From 0bc52d9310aa69120d01e0e1f8c27e25b71a89ad Mon Sep 17 00:00:00 2001 From: Ian Ross Date: Fri, 31 Aug 2018 16:37:36 +0100 Subject: [PATCH] Normalise line endings in specification files 1025 / 11257 of the JSON files in the specifications directory have CRLF line endings, this change ensures consistency across all of the line endings by normalising to just LF. This change touches a lot of files, so understandably might be rejected. --- .../2014-01-01/ADHybridHealthService.json | 12742 ++-- .../2014-01-01/examples/AddAlertFeedback.json | 60 +- .../2014-01-01/examples/AddService.json | 146 +- .../examples/AddServiceMembers.json | 244 +- .../examples/AddUserPreference.json | 36 +- .../examples/AddomainServiceMembers.json | 178 +- .../examples/AddsConfiguration.json | 48 +- .../examples/AddsServiceMembers.json | 170 +- .../stable/2014-01-01/examples/Alerts.json | 146 +- .../examples/BadPasswordDetails.json | 40 +- .../examples/CheckFeatureAvailibility.json | 26 +- .../2014-01-01/examples/Connectors.json | 208 +- .../2014-01-01/examples/Credentials.json | 44 +- .../2014-01-01/examples/Datafreshness.json | 38 +- .../2014-01-01/examples/DeleteServer.json | 18 +- .../2014-01-01/examples/DeleteService.json | 18 +- .../examples/DeleteUserPreference.json | 18 +- .../stable/2014-01-01/examples/DevOps.json | 22 +- .../2014-01-01/examples/Dimensions.json | 98 +- .../2014-01-01/examples/ErrorCounts.json | 96 +- .../2014-01-01/examples/ExportErrors.json | 46 +- .../2014-01-01/examples/ExportStatus.json | 44 +- .../2014-01-01/examples/ForestSummary.json | 44 +- .../2014-01-01/examples/GetAlertFeedback.json | 48 +- .../examples/GlobalConfiguration.json | 52 +- .../examples/MergedExportErrors.json | 132 +- .../2014-01-01/examples/MetricMetadata.json | 62 +- .../examples/MetricMetadataList.json | 74 +- .../2014-01-01/examples/MetricSets.json | 144 +- .../stable/2014-01-01/examples/Metrics.json | 58 +- .../examples/MonitoringConfigurations.json | 50 +- .../2014-01-01/examples/OperationList.json | 50 +- .../PatchMonitoringConfiguration.json | 24 +- .../2014-01-01/examples/PatchTenant.json | 82 +- .../examples/ReplicationDetails.json | 88 +- .../examples/ReplicationStatus.json | 32 +- .../examples/ReplicationSummary.json | 88 +- .../2014-01-01/examples/Server_Alerts.json | 150 +- .../examples/Server_ExportStatus.json | 46 +- .../examples/Server_MetricSets.json | 146 +- .../stable/2014-01-01/examples/Service.json | 82 +- .../examples/ServiceConfiguration.json | 42 +- .../2014-01-01/examples/ServiceMember.json | 134 +- .../2014-01-01/examples/ServiceMembers.json | 146 +- .../examples/Service_MetricSets.json | 146 +- .../stable/2014-01-01/examples/Services.json | 96 +- .../stable/2014-01-01/examples/Tenant.json | 72 +- .../examples/TenantWhitelisting.json | 26 +- .../2014-01-01/examples/UpdateService.json | 94 +- .../2014-01-01/examples/UpdateTenant.json | 74 +- .../2014-01-01/examples/UserPreference.json | 32 +- .../preview/2016-07-12-preview/advisor.json | 2 +- .../examples/CreateSuppression.json | 2 +- .../examples/DeleteSuppression.json | 2 +- .../examples/GenerateRecommendations.json | 2 +- .../examples/GetRecommendationDetail.json | 2 +- .../examples/GetSuppressionDetail.json | 2 +- .../examples/ListRecommendations.json | 2 +- .../examples/ListSuppressions.json | 2 +- .../PollGenerateRecommendationsStatus.json | 2 +- .../stable/2017-03-31/advisor.json | 2 +- .../examples/CreateSuppression.json | 2 +- .../examples/DeleteSuppression.json | 2 +- .../examples/GenerateRecommendations.json | 2 +- .../examples/GetRecommendationDetail.json | 2 +- .../examples/GetSuppressionDetail.json | 2 +- .../examples/ListRecommendations.json | 2 +- .../2017-03-31/examples/ListSuppressions.json | 2 +- .../PollGenerateRecommendationsStatus.json | 2 +- .../examples/CreateConfiguration.json | 2 +- .../examples/CreateSuppression.json | 2 +- .../examples/DeleteSuppression.json | 2 +- .../2017-04-19/examples/EmptyResponse.json | 2 +- .../examples/GenerateRecommendations.json | 2 +- .../examples/GetRecommendationDetail.json | 2 +- .../examples/GetSuppressionDetail.json | 2 +- .../examples/ListConfigurations.json | 2 +- .../examples/ListRecommendations.json | 2 +- .../2017-04-19/examples/ListSuppressions.json | 2 +- .../PollGenerateRecommendationsStatus.json | 2 +- .../stable/2016-10-10/apimdeployment.json | 2 +- .../stable/2016-10-10/apimnetworkstatus.json | 2 +- .../2015-05-01/examples/AnnotationsList.json | 62 +- .../2015-05-01/examples/FavoriteAdd.json | 84 +- .../2015-05-01/examples/FavoriteDelete.json | 24 +- .../2015-05-01/examples/FavoriteGet.json | 48 +- .../2015-05-01/examples/FavoriteUpdate.json | 88 +- .../2015-05-01/examples/FavoritesList.json | 74 +- .../examples/WebTestLocationsList.json | 154 +- .../createSoftwareUpdateConfiguration.json | 302 +- .../getSoftwareUpdateConfigurationByName.json | 124 +- .../examples/listFieldsByModuleAndType.json | 60 +- .../2015-10-31/examples/listFieldsByType.json | 58 +- .../2016-01-01/examples/Operations/List.json | 28 +- .../examples/InfraRole/Restart.json | 26 +- .../2015-06-15/examples/Operations/List.json | 28 +- .../preview/2016-05-01/acquisitions.json | 340 +- .../preview/2016-05-01/blobServices.json | 490 +- .../preview/2016-05-01/containers.json | 898 +- .../preview/2016-05-01/farms.json | 1404 +- .../preview/2016-05-01/queueServices.json | 414 +- .../preview/2016-05-01/quotas.json | 526 +- .../preview/2016-05-01/shares.json | 556 +- .../preview/2016-05-01/storage.json | 1150 +- .../preview/2016-05-01/storageaccounts.json | 882 +- .../preview/2016-05-01/tableServices.json | 414 +- .../examples/KustoClustersDelete.json | 2 +- .../examples/KustoClustersGet.json | 2 +- .../examples/KustoClustersList.json | 2 +- .../KustoClustersListByResourceGroup.json | 2 +- .../examples/KustoClustersUpdate.json | 2 +- .../examples/KustoDatabasesDelete.json | 2 +- .../examples/KustoDatabasesGet.json | 2 +- .../examples/KustoDatabasesListByCluster.json | 2 +- .../examples/KustoDatabasesUpdate.json | 2 +- .../examples/KustoOperationsList.json | 2 +- .../stable/2017-01-01.4.0/BatchService.json | 2 +- .../stable/2017-05-01.5.0/BatchService.json | 2 +- .../stable/2017-01-01/BatchManagement.json | 2 +- .../preview/2017-02-27-preview/billing.json | 2 +- .../preview/2017-04-24-preview/billing.json | 2 +- .../preview/2017-12-01/botservice.json | 4496 +- .../examples/CheckNameAvailability.json | 32 +- .../2017-12-01/examples/CreateBot.json | 214 +- .../2017-12-01/examples/DeleteBot.json | 26 +- .../preview/2017-12-01/examples/GetBot.json | 88 +- .../2017-12-01/examples/GetOperations.json | 104 +- .../examples/ListBotsByResourceGroup.json | 94 +- .../examples/ListBotsBySubscription.json | 92 +- .../2017-12-01/examples/UpdateBot.json | 218 +- .../2018-07-12/examples/CreateBot.json | 2 +- .../2018-07-12/examples/DeleteBot.json | 2 +- .../2018-07-12/examples/GetOperations.json | 2 +- .../examples/ListBotsByResourceGroup.json | 2 +- .../examples/ListBotsBySubscription.json | 2 +- .../2018-07-12/examples/UpdateBot.json | 2 +- ...CheckNameAvailabilityWithSubscription.json | 36 +- .../examples/SuccessfulEntitiesRequest.json | 192 +- .../examples/CreateAnImageFromABlob.json | 84 +- .../CreateAnImageFromAManagedDisk.json | 92 +- .../examples/CreateAnImageFromASnapshot.json | 92 +- .../examples/CreateAnImageFromAVM.json | 86 +- ...AnImageThatIncludesADataDiskFromABlob.json | 106 +- ...ThatIncludesADataDiskFromAManagedDisk.json | 122 +- ...ageThatIncludesADataDiskFromASnapshot.json | 122 +- .../GetInformationAboutAManagedDisk.json | 92 +- .../GetInformationAboutASnapshot.json | 92 +- .../examples/GetInformationAboutAnImage.json | 94 +- .../examples/ListImagesInAResourceGroup.json | 96 +- .../examples/ListImagesInASubscription.json | 94 +- .../ListManagedDisksInAResourceGroup.json | 204 +- .../ListManagedDisksInASubscription.json | 202 +- .../ListSnapshotsInAResourceGroup.json | 98 +- .../ListSnapshotsInASubscription.json | 168 +- ...geVmFromAnUnmanagedGeneralizedOsImage.json | 292 +- ...formImageScaleSetWithUnmanagedOsDisks.json | 290 +- ...ormImageVmWithUnmanagedOsAndDataDisks.json | 428 +- .../CreateAScaleSetFromACustomImage.json | 264 +- ...ateAScaleSetWithAMarketplaceImagePlan.json | 298 +- ...ScaleSetWithAnAzureApplicationGateway.json | 298 +- ...reateAScaleSetWithAnAzureLoadBalancer.json | 318 +- .../CreateAScaleSetWithBootDiagnostics.json | 302 +- ...teAScaleSetWithEmptyDataDisksOnEachVm.json | 342 +- ...teAScaleSetWithPasswordAuthentication.json | 278 +- .../CreateAScaleSetWithPremiumStorage.json | 278 +- .../CreateAScaleSetWithSshAuthentication.json | 312 +- .../examples/CreateAVmFromACustomImage.json | 290 +- .../CreateAVmInAnAvailabilitySet.json | 326 +- .../CreateAVmWithAMarketplaceImagePlan.json | 338 +- .../CreateAVmWithBootDiagnostics.json | 344 +- .../examples/CreateAVmWithEmptyDataDisks.json | 408 +- .../CreateAVmWithPasswordAuthentication.json | 308 +- .../examples/CreateAVmWithPremiumStorage.json | 308 +- .../CreateAVmWithSshAuthentication.json | 356 +- .../examples/CreateAnAvailabilitySet.json | 64 +- ...geVmFromAnUnmanagedGeneralizedOsImage.json | 292 +- ...formImageScaleSetWithUnmanagedOsDisks.json | 444 +- ...ormImageVmWithUnmanagedOsAndDataDisks.json | 428 +- .../CreateAScaleSetFromACustomImage.json | 408 +- ...ateAScaleSetWithAMarketplaceImagePlan.json | 460 +- ...ScaleSetWithAnAzureApplicationGateway.json | 460 +- ...reateAScaleSetWithAnAzureLoadBalancer.json | 490 +- .../CreateAScaleSetWithBootDiagnostics.json | 466 +- ...teAScaleSetWithEmptyDataDisksOnEachVm.json | 534 +- ...teAScaleSetWithPasswordAuthentication.json | 430 +- .../CreateAScaleSetWithPremiumStorage.json | 430 +- .../CreateAScaleSetWithSshAuthentication.json | 478 +- .../examples/CreateAVmFromACustomImage.json | 290 +- .../CreateAVmInAnAvailabilitySet.json | 326 +- .../CreateAVmWithAMarketplaceImagePlan.json | 338 +- .../CreateAVmWithBootDiagnostics.json | 344 +- .../examples/CreateAVmWithEmptyDataDisks.json | 408 +- .../CreateAVmWithPasswordAuthentication.json | 308 +- .../examples/CreateAVmWithPremiumStorage.json | 308 +- .../CreateAVmWithSshAuthentication.json | 356 +- .../examples/CreateAnAvailabilitySet.json | 64 +- .../examples/CreateAnImageFromABlob.json | 124 +- .../CreateAnImageFromAManagedDisk.json | 136 +- .../examples/CreateAnImageFromASnapshot.json | 136 +- .../examples/CreateAnImageFromAVM.json | 136 +- ...AnImageThatIncludesADataDiskFromABlob.json | 156 +- ...ThatIncludesADataDiskFromAManagedDisk.json | 180 +- ...ageThatIncludesADataDiskFromASnapshot.json | 180 +- .../examples/GetInformationAboutAnImage.json | 98 +- .../examples/ListImagesInAResourceGroup.json | 100 +- .../examples/ListImagesInASubscription.json | 98 +- ...reateAScaleSetWithVMsInDifferentZones.json | 568 +- .../2017-04-24-preview/consumption.json | 2 +- .../2016-06-27-preview/containerregistry.json | 1082 +- .../2017-09-01-preview/datafactory.json | 7802 +-- .../entityTypes/Dataset.json | 2888 +- .../entityTypes/IntegrationRuntime.json | 1918 +- .../entityTypes/Pipeline.json | 5756 +- .../entityTypes/Trigger.json | 854 +- .../ActivityRuns_ListByPipelineRun.json | 238 +- .../examples/Datasets_Create.json | 166 +- .../examples/Datasets_Delete.json | 60 +- .../examples/Datasets_Get.json | 106 +- .../examples/Datasets_ListByFactory.json | 112 +- .../examples/Datasets_Update.json | 170 +- .../examples/Factories_CreateOrUpdate.json | 108 +- .../examples/Factories_Delete.json | 56 +- .../examples/Factories_Get.json | 66 +- .../examples/Factories_List.json | 98 +- .../Factories_ListByResourceGroup.json | 100 +- .../examples/Factories_Update.json | 76 +- .../examples/IntegrationRuntimes_Create.json | 148 +- .../examples/IntegrationRuntimes_Delete.json | 60 +- .../examples/IntegrationRuntimes_Get.json | 92 +- ...IntegrationRuntimes_GetConnectionInfo.json | 44 +- .../IntegrationRuntimes_GetStatus.json | 54 +- .../IntegrationRuntimes_ListAuthKeys.json | 46 +- .../IntegrationRuntimes_ListByFactory.json | 98 +- ...IntegrationRuntimes_RegenerateAuthKey.json | 50 +- .../examples/IntegrationRuntimes_Start.json | 118 +- .../examples/IntegrationRuntimes_Stop.json | 56 +- .../examples/IntegrationRuntimes_Update.json | 146 +- .../examples/LinkedServices_Create.json | 90 +- .../examples/LinkedServices_Delete.json | 60 +- .../examples/LinkedServices_Get.json | 68 +- .../LinkedServices_ListByFactory.json | 74 +- .../examples/LinkedServices_Update.json | 94 +- .../examples/Operations_List.json | 406 +- .../examples/PipelineRuns_Get.json | 72 +- .../examples/PipelineRuns_QueryByFactory.json | 104 +- .../examples/Pipelines_Create.json | 282 +- .../examples/Pipelines_CreateRun.json | 54 +- .../examples/Pipelines_Delete.json | 60 +- .../examples/Pipelines_Get.json | 164 +- .../examples/Pipelines_ListByFactory.json | 170 +- .../examples/Pipelines_Update.json | 286 +- .../examples/Triggers_Create.json | 156 +- .../examples/Triggers_Delete.json | 60 +- .../examples/Triggers_Get.json | 102 +- .../examples/Triggers_ListByFactory.json | 108 +- .../examples/Triggers_ListRuns.json | 80 +- .../examples/Triggers_Start.json | 40 +- .../examples/Triggers_Stop.json | 40 +- .../examples/Triggers_Update.json | 160 +- .../examples/Catalog_ListTableFragments.json | 62 +- .../examples/Catalog_PreviewTable.json | 62 +- .../Catalog_PreviewTablePartition.json | 64 +- .../stable/2016-05-15/DTL.json | 17454 +++--- .../2015-03-01-preview/applications.json | 866 +- .../preview/2015-03-01-preview/cluster.json | 2322 +- .../2015-03-01-preview/configurations.json | 376 +- .../ChangeHttpConnectivityDisable.json | 40 +- .../ChangeHttpConnectivityEnable.json | 44 +- .../examples/CreateExtension.json | 32 +- .../examples/CreateLinuxHadoopAdlsGen2.json | 174 +- .../examples/DeleteApplication.json | 32 +- .../examples/DeleteExtension.json | 24 +- .../examples/DeleteLinuxHadoopCluster.json | 22 +- .../examples/DeleteScriptAction.json | 22 +- .../DisableLinuxClusterMonitoring.json | 22 +- .../EnableLinuxClusterMonitoring.json | 30 +- .../examples/GetAllApplications.json | 176 +- .../examples/GetApplicationCreated.json | 104 +- .../examples/GetApplicationInProgress.json | 96 +- .../examples/GetExtension.json | 22 +- .../examples/GetHDInsightCapabilities.json | 6470 +- .../examples/GetHDInsightUsages.json | 46 +- .../examples/GetHttpConnectivity.json | 34 +- .../GetLinuxClusterMonitoringStatus.json | 20 +- .../examples/GetLinuxHadoopAllClusters.json | 324 +- ...LinuxHadoopAllClustersInResourceGroup.json | 326 +- .../examples/GetLinuxHadoopCluster.json | 172 +- .../examples/GetLinuxHadoopScriptAction.json | 40 +- .../GetLinuxHadoopScriptExecutionHistory.json | 62 +- .../examples/GetLinuxSparkCluster.json | 178 +- .../examples/GetScriptActionById.json | 58 +- .../examples/GetScriptExecutionHistory.json | 94 +- .../examples/PostExecuteScriptAction.json | 54 +- .../PromoteLinuxHadoopScriptAction.json | 22 +- .../examples/RdpSettingsEnable.json | 52 +- .../examples/ResizeLinuxHadoopCluster.json | 30 +- .../2015-03-01-preview/extensions.json | 780 +- .../preview/2015-03-01-preview/locations.json | 728 +- .../2015-03-01-preview/scriptActions.json | 918 +- .../preview/2018-06-01-preview/cluster.json | 2322 +- .../2018-06-01-preview/configurations.json | 376 +- .../ChangeHttpConnectivityDisable.json | 40 +- .../ChangeHttpConnectivityEnable.json | 44 +- .../examples/CreateExtension.json | 32 +- .../examples/CreateLinuxHadoopAdlsGen2.json | 174 +- .../examples/DeleteApplication.json | 32 +- .../examples/DeleteExtension.json | 24 +- .../examples/DeleteLinuxHadoopCluster.json | 22 +- .../examples/DeleteScriptAction.json | 22 +- .../DisableLinuxClusterMonitoring.json | 22 +- .../EnableLinuxClusterMonitoring.json | 30 +- .../examples/GetAllApplications.json | 176 +- .../examples/GetApplicationCreated.json | 104 +- .../examples/GetApplicationInProgress.json | 96 +- .../examples/GetExtension.json | 22 +- .../examples/GetHDInsightUsages.json | 46 +- .../examples/GetHttpConnectivity.json | 34 +- .../GetLinuxClusterMonitoringStatus.json | 20 +- .../examples/GetLinuxHadoopAllClusters.json | 324 +- ...LinuxHadoopAllClustersInResourceGroup.json | 326 +- .../examples/GetLinuxHadoopCluster.json | 172 +- .../examples/GetLinuxHadoopScriptAction.json | 40 +- .../GetLinuxHadoopScriptExecutionHistory.json | 62 +- .../examples/GetLinuxSparkCluster.json | 178 +- .../examples/GetScriptActionById.json | 58 +- .../examples/GetScriptExecutionHistory.json | 94 +- .../examples/PostExecuteScriptAction.json | 54 +- .../PromoteLinuxHadoopScriptAction.json | 22 +- .../examples/RdpSettingsEnable.json | 52 +- .../examples/ResizeLinuxHadoopCluster.json | 30 +- .../2018-06-01-preview/extensions.json | 784 +- .../preview/2018-06-01-preview/locations.json | 298 +- .../2018-06-01-preview/scriptActions.json | 918 +- .../iothub_routingendpointhealth.json | 46 +- .../examples/iothub_testallroutes.json | 62 +- .../examples/iothub_testnewroute.json | 94 +- .../2018-04-01/examples/iothub_usages.json | 48 +- .../examples/DeletePartnerDetails.json | 2 +- .../2018-02-01/examples/GetOperations.json | 2 +- .../examples/GetPartnerDetails.json | 2 +- .../examples/PatchPartnerDetails.json | 2 +- .../examples/PutPartnerDetails.json | 2 +- .../stable/2015-10-01/media.json | 1884 +- .../activityLogAlerts_API.json | 2 +- .../2017-12-01/examples/ServerList.json | 2 +- .../examples/RouteFilterCreate.json | 2 +- .../2016-12-01/examples/RouteFilterGet.json | 2 +- .../2016-12-01/examples/RouteFilterList.json | 2 +- .../RouteFilterListByResourceGroup.json | 2 +- .../examples/RouteFilterRuleCreate.json | 2 +- .../examples/RouteFilterRuleGet.json | 2 +- .../RouteFilterRuleListByRouteFilter.json | 2 +- .../examples/RouteFilterRuleUpdate.json | 2 +- .../examples/RouteFilterUpdate.json | 2 +- .../examples/ServiceCommunityList.json | 2 +- .../stable/2016-12-01/routeFilter.json | 2 +- .../stable/2016-12-01/serviceCommunity.json | 2 +- .../examples/RouteFilterCreate.json | 2 +- .../2017-03-01/examples/RouteFilterGet.json | 2 +- .../2017-03-01/examples/RouteFilterList.json | 2 +- .../RouteFilterListByResourceGroup.json | 2 +- .../examples/RouteFilterRuleCreate.json | 2 +- .../examples/RouteFilterRuleGet.json | 2 +- .../RouteFilterRuleListByRouteFilter.json | 2 +- .../examples/RouteFilterRuleUpdate.json | 2 +- .../examples/RouteFilterUpdate.json | 2 +- .../examples/ServiceCommunityList.json | 2 +- .../2017-03-01/examples/VmssPublicIpGet.json | 62 +- .../examples/VmssPublicIpListAll.json | 94 +- .../examples/VmssVmPublicIpList.json | 68 +- .../stable/2017-03-01/routeFilter.json | 2 +- .../stable/2017-03-01/serviceCommunity.json | 2 +- .../stable/2017-03-01/virtualNetwork.json | 2 +- .../2017-03-01/vmssPublicIpAddress.json | 520 +- .../stable/2017-06-01/endpointService.json | 254 +- .../examples/CheckDnsNameAvailability.json | 30 +- .../examples/DefaultSecurityRuleGet.json | 66 +- .../examples/DefaultSecurityRuleList.json | 272 +- .../examples/EndpointServicesList.json | 58 +- .../examples/InboundNatRuleCreate.json | 124 +- .../examples/InboundNatRuleDelete.json | 26 +- .../examples/InboundNatRuleGet.json | 62 +- .../examples/InboundNatRuleList.json | 104 +- .../examples/LoadBalancerCreate.json | 648 +- .../examples/LoadBalancerCreateWithZones.json | 670 +- .../examples/LoadBalancerDelete.json | 26 +- .../2017-06-01/examples/LoadBalancerGet.json | 242 +- .../2017-06-01/examples/LoadBalancerList.json | 280 +- .../examples/LoadBalancerListAll.json | 278 +- .../examples/NetworkInterfaceCreate.json | 194 +- .../examples/NetworkInterfaceDelete.json | 24 +- .../NetworkInterfaceEffectiveNSGList.json | 140 +- ...tworkInterfaceEffectiveRouteTableList.json | 140 +- .../examples/NetworkInterfaceGet.json | 106 +- .../examples/NetworkInterfaceList.json | 178 +- .../examples/NetworkInterfaceListAll.json | 176 +- .../examples/NetworkSecurityGroupCreate.json | 462 +- .../NetworkSecurityGroupCreateWithRule.json | 562 +- .../examples/NetworkSecurityGroupDelete.json | 26 +- .../examples/NetworkSecurityGroupGet.json | 272 +- .../examples/NetworkSecurityGroupList.json | 462 +- .../examples/NetworkSecurityGroupListAll.json | 460 +- .../NetworkSecurityGroupRuleCreate.json | 114 +- .../NetworkSecurityGroupRuleDelete.json | 28 +- .../examples/NetworkSecurityGroupRuleGet.json | 56 +- .../NetworkSecurityGroupRuleList.json | 62 +- ...PublicIpAddressCreateCustomizedValues.json | 106 +- .../PublicIpAddressCreateDefaults.json | 88 +- .../examples/PublicIpAddressCreateDns.json | 116 +- .../examples/PublicIpAddressDelete.json | 24 +- .../examples/PublicIpAddressGet.json | 52 +- .../examples/PublicIpAddressList.json | 98 +- .../examples/PublicIpAddressListAll.json | 96 +- .../2017-06-01/examples/RouteTableCreate.json | 70 +- .../examples/RouteTableCreateWithRoute.json | 134 +- .../2017-06-01/examples/RouteTableDelete.json | 26 +- .../2017-06-01/examples/RouteTableGet.json | 64 +- .../2017-06-01/examples/RouteTableList.json | 90 +- .../examples/RouteTableListAll.json | 88 +- .../examples/RouteTableRouteCreate.json | 78 +- .../examples/RouteTableRouteDelete.json | 28 +- .../examples/RouteTableRouteGet.json | 44 +- .../examples/RouteTableRouteList.json | 68 +- .../2017-06-01/examples/SubnetCreate.json | 70 +- .../examples/SubnetCreateServiceEndpoint.json | 108 +- .../2017-06-01/examples/SubnetDelete.json | 26 +- .../stable/2017-06-01/examples/SubnetGet.json | 40 +- .../2017-06-01/examples/SubnetList.json | 62 +- .../stable/2017-06-01/examples/UsageList.json | 226 +- ...tualNetworkCheckIPAddressAvailability.json | 46 +- .../examples/VirtualNetworkCreate.json | 112 +- .../examples/VirtualNetworkCreateSubnet.json | 162 +- .../examples/VirtualNetworkDelete.json | 24 +- .../examples/VirtualNetworkGet.json | 82 +- .../examples/VirtualNetworkList.json | 128 +- .../examples/VirtualNetworkListAll.json | 126 +- .../examples/VirtualNetworkPeeringCreate.json | 110 +- .../examples/VirtualNetworkPeeringDelete.json | 26 +- .../examples/VirtualNetworkPeeringGet.json | 54 +- .../examples/VirtualNetworkPeeringList.json | 90 +- .../examples/VmssNetworkInterfaceGet.json | 130 +- .../examples/VmssNetworkInterfaceList.json | 236 +- .../examples/VmssVmNetworkInterfaceList.json | 136 +- .../stable/2017-08-01/endpointService.json | 254 +- .../examples/EndpointServicesList.json | 58 +- .../examples/LoadBalancerCreateWithZones.json | 670 +- .../examples/SubnetCreateServiceEndpoint.json | 108 +- .../ApplicationGatewayUpdateTags.json | 294 +- .../ExpressRouteCircuitUpdateTags.json | 96 +- .../examples/LoadBalancerCreateWithZones.json | 670 +- .../examples/LoadBalancerUpdateTags.json | 264 +- .../LocalNetworkGatewayUpdateTags.json | 76 +- .../examples/NetworkInterfaceUpdateTags.json | 110 +- .../NetworkSecurityGroupUpdateTags.json | 260 +- .../examples/NetworkWatcherUpdateTags.json | 64 +- .../2017-09-01/examples/OperationList.json | 272 +- .../examples/PublicIpAddressUpdateTags.json | 74 +- .../examples/RouteTableUpdateTags.json | 64 +- .../examples/UsageListSpacedLocation.json | 528 +- ...ualNetworkGatewayConnectionUpdateTags.json | 94 +- .../VirtualNetworkGatewayUpdateTags.json | 124 +- .../examples/VirtualNetworkUpdateTags.json | 78 +- .../VmssNetworkInterfaceIpConfigGet.json | 78 +- .../VmssNetworkInterfaceIpConfigList.json | 84 +- .../stable/2017-09-01/operation.json | 558 +- .../ApplicationGatewayUpdateTags.json | 294 +- .../ExpressRouteCircuitUpdateTags.json | 96 +- .../examples/LoadBalancerUpdateTags.json | 264 +- .../LocalNetworkGatewayUpdateTags.json | 76 +- .../examples/NetworkInterfaceUpdateTags.json | 110 +- .../NetworkSecurityGroupUpdateTags.json | 260 +- .../examples/NetworkWatcherUpdateTags.json | 64 +- .../2017-10-01/examples/OperationList.json | 272 +- .../examples/PublicIpAddressUpdateTags.json | 74 +- .../examples/RouteTableUpdateTags.json | 64 +- ...ualNetworkGatewayConnectionUpdateTags.json | 94 +- .../VirtualNetworkGatewayUpdateTags.json | 124 +- .../examples/VirtualNetworkUpdateTags.json | 78 +- .../VmssNetworkInterfaceIpConfigGet.json | 78 +- .../VmssNetworkInterfaceIpConfigList.json | 84 +- .../stable/2017-10-01/operation.json | 558 +- .../stable/2018-07-01/usage.json | 6 +- .../2016-06-01/registeredidentities.json | 734 +- .../stable/2016-06-01/replicationusages.json | 414 +- .../stable/2016-06-01/vaults.json | 1766 +- .../stable/2016-06-01/vaultusages.json | 376 +- .../stable/2016-04-01/redis.json | 2 +- .../2018-06-01/examples/GetOperations.json | 2 +- .../examples/GetReservationDetails.json | 2 +- .../examples/GetReservationOrderDetails.json | 2 +- .../examples/GetReservationOrders.json | 2 +- .../examples/GetReservationRevisions.json | 2 +- .../2018-06-01/examples/GetReservations.json | 2 +- .../2017-11-01/examples/GetOperations.json | 2 +- .../examples/GetReservationDetails.json | 2 +- .../examples/GetReservationOrderDetails.json | 2 +- .../examples/GetReservationOrders.json | 2 +- .../examples/GetReservationRevisions.json | 2 +- .../2017-11-01/examples/GetReservations.json | 2 +- .../AvailabilityStatus_GetByResource.json | 2 +- ...ilabilityStatuses_ListByResourceGroup.json | 2 +- ...labilityStatuses_ListBySubscriptionId.json | 2 +- .../examples/Availabilitystatuses_List.json | 2 +- .../AvailabilityStatus_GetByResource.json | 2 +- ...ilabilityStatuses_ListByResourceGroup.json | 2 +- ...labilityStatuses_ListBySubscriptionId.json | 2 +- .../examples/Availabilitystatuses_List.json | 2 +- ...GetAlertResourceGroupLocation_example.json | 142 +- .../GetAlertSubscriptionLocation_example.json | 140 +- ...etAlertsResourceGroupLocation_example.json | 144 +- .../GetAlertsResourceGroup_example.json | 142 +- .../Alerts/GetAlertsSubscription_example.json | 298 +- ...etAlertsSubscriptionsLocation_example.json | 306 +- ...ateAlertResourceGroupLocation_example.json | 26 +- ...dateAlertSubscriptionLocation_example.json | 24 +- ...SolutionResourceGroupLocation_example.json | 50 +- ...SolutionsSubscriptionLocation_example.json | 78 +- ...SecuritySolutionsSubscription_example.json | 76 +- .../GetExternalSecuritySolution_example.json | 54 +- ...SolutionsSubscriptionLocation_example.json | 244 +- ...SecuritySolutionsSubscription_example.json | 242 +- .../CreateJitNetworkAccessPolicy_example.json | 184 +- .../DeleteJitNetworkAccessPolicy_example.json | 28 +- ...PoliciesResourceGroupLocation_example.json | 106 +- ...rkAccessPoliciesResourceGroup_example.json | 104 +- ...sPoliciesSubscriptionLocation_example.json | 104 +- ...orkAccessPoliciesSubscription_example.json | 102 +- .../GetJitNetworkAccessPolicy_example.json | 104 +- ...nitiateJitNetworkAccessPolicy_example.json | 74 +- .../InvokeJitNetworkAccessPolicy_example.json | 54 +- .../Locations/GetLocation_example.json | 36 +- .../Locations/GetLocations_example.json | 38 +- .../GetTaskResourceGroupLocation_example.json | 66 +- .../GetTaskSubscriptionLocation_example.json | 64 +- ...GetTasksResourceGroupLocation_example.json | 72 +- .../GetTasksSubscriptionLocation_example.json | 110 +- .../Tasks/GetTasksSubscription_example.json | 108 +- ...dateTaskResourceGroupLocation_example.json | 26 +- ...pdateTaskSubscriptionLocation_example.json | 24 +- .../preview/2015-06-01-preview/security.json | 5358 +- ...visioningSettingsSubscription_example.json | 52 +- ...ovisioningSettingSubscription_example.json | 36 +- ...visioningSettingsSubscription_example.json | 38 +- .../Compliances/GetCompliance_example.json | 50 +- .../Compliances/GetCompliances_example.json | 118 +- .../CreatePricingsResourceGroup_example.json | 54 +- .../CreatePricingsSubscription_example.json | 52 +- .../GetPricingResourceGroup_example.json | 38 +- .../GetPricingSubscription_example.json | 36 +- .../GetPricingsResourceGroup_example.json | 40 +- .../GetPricingsSubscription_example.json | 38 +- .../CreateSecurityContact_example.json | 64 +- .../DeleteSecurityContact_example.json | 20 +- .../GetSecurityContact_example.json | 42 +- ...tSecurityContactsSubscription_example.json | 44 +- .../UpdateSecurityContact_example.json | 60 +- .../examples/Settings/GetSetting_example.json | 38 +- .../Settings/GetSettings_example.json | 62 +- .../Settings/UpdateSetting_example.json | 56 +- .../CreateWorkspaceSetting_example.json | 56 +- .../DeleteWorkspaceSetting_example.json | 20 +- .../GetWorkspaceSetting_example.json | 38 +- .../GetWorkspaceSettings_example.json | 60 +- .../UpdateWorkspaceSetting_example.json | 54 +- .../preview/2017-08-01-preview/security.json | 2946 +- .../6.2/examples/BackupPartition-1.json | 26 +- .../6.2/examples/BackupPartition-2.json | 36 +- .../6.2/examples/BackupPartition-3.json | 38 +- .../6.2/examples/CreateApplication-1.json | 32 +- .../6.2/examples/CreateBackupPolicy-1.json | 58 +- .../6.2/examples/CreateBackupPolicy-2.json | 52 +- .../stable/6.2/examples/CreateName-1.json | 28 +- .../stable/6.2/examples/CreateService-1.json | 40 +- .../stable/6.2/examples/CreateService-2.json | 44 +- .../stable/6.2/examples/CreateService-3.json | 92 +- .../stable/6.2/examples/CreateService-4.json | 86 +- .../6.2/examples/DeleteBackupPolicy.json | 22 +- .../examples/DisableApplicationBackup.json | 22 +- .../6.2/examples/DisablePartitionBackup.json | 22 +- .../6.2/examples/DisableServiceBackup.json | 22 +- .../6.2/examples/EnableApplicationBackup.json | 28 +- .../6.2/examples/EnablePartitionBackup.json | 28 +- .../6.2/examples/EnableServiceBackup.json | 28 +- .../GetAllEntitiesBackedUpByPolicy-1.json | 56 +- .../GetAllEntitiesBackedUpByPolicy-2.json | 50 +- ...tApplicationBackupConfigurationInfo-1.json | 80 +- ...tApplicationBackupConfigurationInfo-2.json | 64 +- .../examples/GetApplicationBackupList-1.json | 210 +- .../examples/GetApplicationBackupList-2.json | 124 +- .../examples/GetApplicationBackupList-3.json | 124 +- .../examples/GetApplicationBackupList-4.json | 126 +- .../6.2/examples/GetApplicationEventList.json | 56 +- .../examples/GetApplicationInfoByName-1.json | 54 +- .../examples/GetApplicationInfoList-1.json | 78 +- .../examples/GetApplicationInfoList-2.json | 60 +- .../GetApplicationTypeInfoList-1.json | 172 +- .../GetApplicationTypeInfoList-2.json | 100 +- .../GetApplicationTypeInfoList-3.json | 122 +- .../examples/GetApplicationsEventList.json | 74 +- .../6.2/examples/GetBackupPolicyByName.json | 62 +- .../6.2/examples/GetBackupPolicyList-1.json | 108 +- .../6.2/examples/GetBackupPolicyList-2.json | 76 +- .../GetBackupsFromBackupLocation-1.json | 144 +- .../GetBackupsFromBackupLocation-2.json | 146 +- .../stable/6.2/examples/GetChaosEvents.json | 126 +- .../6.2/examples/GetClusterEventList.json | 112 +- .../GetContainerLogsDeployedOnNode-1.json | 38 +- .../GetContainerLogsDeployedOnNode-2.json | 40 +- .../GetContainerLogsDeployedOnNode-3.json | 40 +- .../6.2/examples/GetCorrelatedEventList.json | 62 +- .../examples/GetDataLossProgress-Running.json | 36 +- .../6.2/examples/GetDataLossProgress.json | 50 +- .../GetDeployedApplicationInfoByName-1.json | 56 +- .../GetDeployedApplicationInfoList-1.json | 80 +- .../GetDeployedApplicationInfoList-2.json | 60 +- .../GetDeployedApplicationInfoList-3.json | 100 +- .../6.2/examples/GetFaultOperationList.json | 106 +- .../6.2/examples/GetImageStoreContent.json | 184 +- .../stable/6.2/examples/GetNodeEventList.json | 66 +- .../stable/6.2/examples/GetNodeInfoList.json | 350 +- .../GetNodeTransitionProgress-Running.json | 34 +- .../examples/GetNodeTransitionProgress.json | 48 +- .../6.2/examples/GetNodesEventList.json | 94 +- .../GetPartitionBackupConfigurationInfo.json | 50 +- .../examples/GetPartitionBackupList-1.json | 126 +- .../examples/GetPartitionBackupList-2.json | 82 +- .../examples/GetPartitionBackupList-3.json | 124 +- .../examples/GetPartitionBackupList-4.json | 84 +- .../examples/GetPartitionBackupProgress.json | 50 +- .../6.2/examples/GetPartitionEventList.json | 76 +- .../examples/GetPartitionRestartProgress.json | 50 +- .../examples/GetPartitionRestoreProgress.json | 46 +- .../6.2/examples/GetPartitionsEventList.json | 114 +- .../6.2/examples/GetPropertyInfo-1.json | 60 +- .../6.2/examples/GetPropertyInfoList-1.json | 86 +- .../6.2/examples/GetPropertyInfoList-2.json | 102 +- .../6.2/examples/GetPropertyInfoList-3.json | 74 +- .../GetQuorumLossProgress-Running.json | 36 +- .../6.2/examples/GetQuorumLossProgress.json | 50 +- .../6.2/examples/GetReplicaEventList.json | 72 +- .../6.2/examples/GetReplicasEventList.json | 104 +- .../GetServiceBackupConfigurationInfo-1.json | 82 +- .../GetServiceBackupConfigurationInfo-2.json | 64 +- .../6.2/examples/GetServiceBackupList-1.json | 210 +- .../6.2/examples/GetServiceBackupList-2.json | 124 +- .../6.2/examples/GetServiceBackupList-3.json | 124 +- .../6.2/examples/GetServiceBackupList-4.json | 126 +- .../6.2/examples/GetServiceEventList.json | 70 +- .../examples/GetServiceTypeInfoByName-1.json | 78 +- .../examples/GetServiceTypeInfoList-1.json | 72 +- .../6.2/examples/GetServicesEventList.json | 102 +- .../6.2/examples/GetSubNameInfoList-1.json | 44 +- .../6.2/examples/GetSubNameInfoList-2.json | 56 +- .../6.2/examples/GetSubNameInfoList-3.json | 48 +- .../6.2/examples/GetUploadSessionById.json | 68 +- .../6.2/examples/GetUploadSessionByPath.json | 100 +- .../6.2/examples/InvokeContainerApi.json | 52 +- .../6.2/examples/InvokeContainerApi_Post.json | 56 +- .../stable/6.2/examples/PutProperty-1.json | 38 +- .../stable/6.2/examples/PutProperty-2.json | 40 +- .../stable/6.2/examples/RestorePartition.json | 40 +- .../6.2/examples/ResumeApplicationBackup.json | 22 +- .../6.2/examples/ResumePartitionBackup.json | 22 +- .../6.2/examples/ResumeServiceBackup.json | 22 +- .../6.2/examples/SubmitPropertyBatch-1.json | 134 +- .../examples/SuspendApplicationBackup.json | 22 +- .../6.2/examples/SuspendPartitionBackup.json | 22 +- .../6.2/examples/SuspendServiceBackup.json | 22 +- .../6.2/examples/UpdateBackupPolicy.json | 60 +- .../stable/6.2/examples/UpdateService-1.json | 66 +- .../stable/6.2/examples/UpdateService-2.json | 32 +- .../stable/6.2/servicefabric.json | 49254 +++++++-------- .../6.3/examples/BackupPartition-1.json | 26 +- .../6.3/examples/BackupPartition-2.json | 36 +- .../6.3/examples/BackupPartition-3.json | 38 +- .../6.3/examples/CreateApplication-1.json | 32 +- .../6.3/examples/CreateBackupPolicy-1.json | 58 +- .../6.3/examples/CreateBackupPolicy-2.json | 52 +- .../stable/6.3/examples/CreateName-1.json | 28 +- .../stable/6.3/examples/CreateService-1.json | 40 +- .../stable/6.3/examples/CreateService-2.json | 44 +- .../stable/6.3/examples/CreateService-3.json | 92 +- .../stable/6.3/examples/CreateService-4.json | 86 +- .../6.3/examples/DeleteBackupPolicy.json | 22 +- .../examples/DisableApplicationBackup.json | 22 +- .../6.3/examples/DisablePartitionBackup.json | 22 +- .../6.3/examples/DisableServiceBackup.json | 22 +- .../6.3/examples/EnableApplicationBackup.json | 28 +- .../6.3/examples/EnablePartitionBackup.json | 28 +- .../6.3/examples/EnableServiceBackup.json | 28 +- .../GetAllEntitiesBackedUpByPolicy-1.json | 56 +- .../GetAllEntitiesBackedUpByPolicy-2.json | 50 +- ...tApplicationBackupConfigurationInfo-1.json | 80 +- ...tApplicationBackupConfigurationInfo-2.json | 64 +- .../examples/GetApplicationBackupList-1.json | 210 +- .../examples/GetApplicationBackupList-2.json | 124 +- .../examples/GetApplicationBackupList-3.json | 124 +- .../examples/GetApplicationBackupList-4.json | 126 +- .../6.3/examples/GetApplicationEventList.json | 56 +- .../examples/GetApplicationInfoByName-1.json | 54 +- .../examples/GetApplicationInfoList-1.json | 78 +- .../examples/GetApplicationInfoList-2.json | 60 +- .../GetApplicationTypeInfoList-1.json | 172 +- .../GetApplicationTypeInfoList-2.json | 100 +- .../GetApplicationTypeInfoList-3.json | 122 +- .../examples/GetApplicationsEventList.json | 74 +- .../6.3/examples/GetBackupPolicyByName.json | 62 +- .../6.3/examples/GetBackupPolicyList-1.json | 108 +- .../6.3/examples/GetBackupPolicyList-2.json | 76 +- .../GetBackupsFromBackupLocation-1.json | 144 +- .../GetBackupsFromBackupLocation-2.json | 146 +- .../stable/6.3/examples/GetChaosEvents.json | 126 +- .../6.3/examples/GetClusterEventList.json | 112 +- .../GetContainerLogsDeployedOnNode-1.json | 38 +- .../GetContainerLogsDeployedOnNode-2.json | 40 +- .../GetContainerLogsDeployedOnNode-3.json | 40 +- .../6.3/examples/GetCorrelatedEventList.json | 62 +- .../examples/GetDataLossProgress-Running.json | 36 +- .../6.3/examples/GetDataLossProgress.json | 50 +- .../GetDeployedApplicationInfoByName-1.json | 56 +- .../GetDeployedApplicationInfoList-1.json | 80 +- .../GetDeployedApplicationInfoList-2.json | 60 +- .../GetDeployedApplicationInfoList-3.json | 100 +- .../6.3/examples/GetFaultOperationList.json | 106 +- .../6.3/examples/GetImageStoreContent.json | 184 +- .../stable/6.3/examples/GetNodeEventList.json | 66 +- .../stable/6.3/examples/GetNodeInfo-1.json | 88 +- .../6.3/examples/GetNodeInfoList-1.json | 144 +- .../6.3/examples/GetNodeInfoList-2.json | 198 +- .../stable/6.3/examples/GetNodeInfoList.json | 304 +- .../GetNodeTransitionProgress-Running.json | 34 +- .../examples/GetNodeTransitionProgress.json | 48 +- .../6.3/examples/GetNodesEventList.json | 94 +- .../GetPartitionBackupConfigurationInfo.json | 50 +- .../examples/GetPartitionBackupList-1.json | 126 +- .../examples/GetPartitionBackupList-2.json | 82 +- .../examples/GetPartitionBackupList-3.json | 124 +- .../examples/GetPartitionBackupList-4.json | 84 +- .../examples/GetPartitionBackupProgress.json | 50 +- .../6.3/examples/GetPartitionEventList.json | 76 +- .../examples/GetPartitionRestartProgress.json | 50 +- .../examples/GetPartitionRestoreProgress.json | 46 +- .../6.3/examples/GetPartitionsEventList.json | 114 +- .../6.3/examples/GetPropertyInfo-1.json | 60 +- .../6.3/examples/GetPropertyInfoList-1.json | 86 +- .../6.3/examples/GetPropertyInfoList-2.json | 102 +- .../6.3/examples/GetPropertyInfoList-3.json | 74 +- .../GetQuorumLossProgress-Running.json | 36 +- .../6.3/examples/GetQuorumLossProgress.json | 50 +- .../6.3/examples/GetReplicaEventList.json | 72 +- .../6.3/examples/GetReplicasEventList.json | 104 +- .../GetServiceBackupConfigurationInfo-1.json | 82 +- .../GetServiceBackupConfigurationInfo-2.json | 64 +- .../6.3/examples/GetServiceBackupList-1.json | 210 +- .../6.3/examples/GetServiceBackupList-2.json | 124 +- .../6.3/examples/GetServiceBackupList-3.json | 124 +- .../6.3/examples/GetServiceBackupList-4.json | 126 +- .../6.3/examples/GetServiceEventList.json | 70 +- .../examples/GetServiceTypeInfoByName-1.json | 78 +- .../examples/GetServiceTypeInfoList-1.json | 72 +- .../6.3/examples/GetServicesEventList.json | 102 +- .../6.3/examples/GetSubNameInfoList-1.json | 44 +- .../6.3/examples/GetSubNameInfoList-2.json | 56 +- .../6.3/examples/GetSubNameInfoList-3.json | 48 +- .../6.3/examples/GetUploadSessionById.json | 68 +- .../6.3/examples/GetUploadSessionByPath.json | 100 +- .../6.3/examples/InvokeContainerApi.json | 52 +- .../6.3/examples/InvokeContainerApi_Post.json | 56 +- .../stable/6.3/examples/PutProperty-1.json | 38 +- .../stable/6.3/examples/PutProperty-2.json | 40 +- .../CreateOrUpdateApplicationResource.json | 90 +- .../CreateOrUpdateVolumeResource.json | 46 +- .../Resource/DeleteApplicationResource.json | 24 +- .../Resource/DeleteVolumeResource.json | 24 +- .../Resource/GetApplicationResource.json | 44 +- .../6.3/examples/Resource/GetReplica.json | 94 +- .../6.3/examples/Resource/GetReplicas.json | 170 +- .../6.3/examples/Resource/GetService.json | 82 +- .../6.3/examples/Resource/GetServices.json | 90 +- .../examples/Resource/GetVolumeResource.json | 44 +- .../stable/6.3/examples/RestorePartition.json | 40 +- .../6.3/examples/ResumeApplicationBackup.json | 22 +- .../6.3/examples/ResumePartitionBackup.json | 22 +- .../6.3/examples/ResumeServiceBackup.json | 22 +- .../StartClusterConfigurationUpgrade-1.json | 84 +- .../6.3/examples/SubmitPropertyBatch-1.json | 134 +- .../examples/SuspendApplicationBackup.json | 22 +- .../6.3/examples/SuspendPartitionBackup.json | 22 +- .../6.3/examples/SuspendServiceBackup.json | 22 +- .../6.3/examples/UpdateBackupPolicy.json | 60 +- .../stable/6.3/examples/UpdateService-1.json | 66 +- .../stable/6.3/examples/UpdateService-2.json | 32 +- .../stable/6.3/servicefabric.json | 51772 ++++++++-------- .../2017-07-01-preview/application.json | 4220 +- .../ApplicationDeleteOperation_example.json | 34 +- .../ApplicationGetOperation_example.json | 124 +- .../ApplicationListOperation_example.json | 80 +- .../ApplicationPatchOperation_example.json | 118 +- .../ApplicationPutOperation_example_max.json | 222 +- .../ApplicationPutOperation_example_min.json | 86 +- ...cationTypeNameDeleteOperation_example.json | 34 +- ...plicationTypeNameGetOperation_example.json | 50 +- ...licationTypeNameListOperation_example.json | 58 +- ...plicationTypeNamePutOperation_example.json | 64 +- ...ionTypeVersionDeleteOperation_example.json | 36 +- ...cationTypeVersionGetOperation_example.json | 56 +- ...ationTypeVersionListOperation_example.json | 64 +- ...cationTypeVersionPutOperation_example.json | 82 +- .../ClusterDeleteOperation_example.json | 26 +- .../examples/ClusterGetOperation_example.json | 290 +- ...rListByResourceGroupOperation_example.json | 470 +- .../ClusterListOperation_example.json | 468 +- .../ClusterPatchOperation_example.json | 332 +- .../ClusterPutOperation_example_max.json | 538 +- .../ClusterPutOperation_example_min.json | 288 +- ...usterVersionsGetByEnvironment_example.json | 56 +- .../examples/ClusterVersionsGet_example.json | 54 +- .../ClusterVersionsListByEnvironment.json | 54 +- .../examples/ClusterVersionsList_example.json | 72 +- .../ServiceDeleteOperation_example.json | 36 +- .../examples/ServiceGetOperation_example.json | 82 +- .../ServiceListOperation_example.json | 84 +- .../ServicePatchOperation_example.json | 116 +- .../ServicePutOperation_example_max.json | 148 +- .../ServicePutOperation_example_min.json | 100 +- .../2017-07-01-preview/servicefabric.json | 6272 +- .../stable/2018-02-01/cluster.json | 3040 +- .../ClusterDeleteOperation_example.json | 26 +- .../examples/ClusterGetOperation_example.json | 318 +- ...rListByResourceGroupOperation_example.json | 496 +- .../ClusterListOperation_example.json | 494 +- .../ClusterPatchOperation_example.json | 342 +- .../ClusterPutOperation_example_max.json | 590 +- .../ClusterPutOperation_example_min.json | 284 +- ...usterVersionsGetByEnvironment_example.json | 56 +- .../examples/ClusterVersionsGet_example.json | 54 +- .../ClusterVersionsListByEnvironment.json | 54 +- .../examples/ClusterVersionsList_example.json | 72 +- .../examples/ApplicationCreateOrUpdate.json | 164 +- .../examples/ApplicationDelete.json | 32 +- .../examples/ApplicationGet.json | 54 +- .../examples/ApplicationsByResourceGroup.json | 92 +- .../ApplicationsBySubscriptionId.json | 348 +- .../examples/ContainerLogsList.json | 36 +- .../examples/NetworkCreateOrUpdate.json | 150 +- .../examples/NetworkDelete.json | 28 +- .../examples/NetworkGet.json | 68 +- .../examples/NetworksByResourceGroup.json | 120 +- .../examples/NetworksBySubscriptionId.json | 118 +- .../examples/ReplicaGet.json | 216 +- .../examples/ReplicasGetAll.json | 412 +- .../examples/ServiceGet.json | 112 +- .../examples/ServiceList.json | 122 +- .../examples/VolumeCreate.json | 114 +- .../examples/VolumeDelete.json | 28 +- .../examples/VolumeGet.json | 54 +- .../examples/VolumesByResourceGroup.json | 92 +- .../examples/VolumesBySubscriptionId.json | 90 +- .../2018-07-01-preview/servicefabricmesh.json | 4488 +- .../databaseAutomaticTuning.json | 628 +- .../examples/CancelJobExecution.json | 2 +- .../examples/CreateJobExecution.json | 2 +- .../examples/CreateOrUpdateJobAgentMax.json | 2 +- .../examples/CreateOrUpdateJobAgentMin.json | 2 +- .../examples/CreateOrUpdateJobCredential.json | 2 +- .../examples/CreateOrUpdateJobExecution.json | 2 +- .../examples/CreateOrUpdateJobMax.json | 2 +- .../examples/CreateOrUpdateJobMin.json | 2 +- .../examples/CreateOrUpdateJobStepMax.json | 2 +- .../examples/CreateOrUpdateJobStepMin.json | 2 +- .../CreateOrUpdateJobTargetGroupMax.json | 2 +- .../CreateOrUpdateJobTargetGroupMin.json | 2 +- .../DataWarehouseRestorePointsGet.json | 2 +- .../examples/DatabaseRestorePointsDelete.json | 2 +- .../examples/DatabaseRestorePointsGet.json | 2 +- .../examples/DatabaseRestorePointsPost.json | 2 +- .../examples/DeleteJob.json | 2 +- .../examples/DeleteJobAgent.json | 2 +- .../examples/DeleteJobCredential.json | 2 +- .../examples/DeleteJobStep.json | 2 +- .../examples/DeleteJobTargetGroup.json | 2 +- .../2017-03-01-preview/examples/GetJob.json | 2 +- .../examples/GetJobAgent.json | 2 +- .../examples/GetJobCredential.json | 2 +- .../examples/GetJobExecution.json | 2 +- .../examples/GetJobExecutionStep.json | 2 +- .../examples/GetJobExecutionTarget.json | 2 +- .../examples/GetJobStepByJob.json | 2 +- .../examples/GetJobStepByVersion.json | 2 +- .../examples/GetJobTargetGroup.json | 2 +- .../examples/GetJobVersion.json | 2 +- .../examples/ListJobAgentsByServer.json | 2 +- .../examples/ListJobCredentialsByAgent.json | 2 +- .../examples/ListJobExecutionSteps.json | 2 +- .../ListJobExecutionTargetsByExecution.json | 2 +- .../ListJobExecutionTargetsByStep.json | 2 +- .../ListJobExecutionsByAgentWithFilter.json | 2 +- .../examples/ListJobExecutionsByJob.json | 2 +- .../examples/ListJobStepsByJob.json | 2 +- .../examples/ListJobStepsByVersion.json | 2 +- .../examples/ListJobTargetGroups.json | 2 +- .../examples/ListJobVersions.json | 2 +- .../examples/ListJobsByAgent.json | 2 +- .../LongTermRetentionBackupDelete.json | 2 +- .../examples/LongTermRetentionBackupGet.json | 2 +- ...LongTermRetentionBackupListByDatabase.json | 2 +- ...LongTermRetentionBackupListByLocation.json | 2 +- .../LongTermRetentionBackupListByServer.json | 102 +- ...LongTermRetentionPolicyCreateOrUpdate.json | 62 +- .../examples/LongTermRetentionPolicyGet.json | 2 +- .../examples/ManagedDatabaseCreateMax.json | 2 +- .../examples/ManagedDatabaseCreateMin.json | 2 +- ...nagedDatabaseCreatePointInTimeRestore.json | 2 +- ...edDatabaseCreateRestoreExternalBackup.json | 2 +- .../examples/ManagedDatabaseDelete.json | 2 +- .../examples/ManagedDatabaseGet.json | 2 +- .../ManagedDatabaseListByManagedInstance.json | 2 +- .../examples/ManagedDatabaseUpdateMax.json | 2 +- .../examples/ManagedDatabaseUpdateMin.json | 2 +- .../examples/ServerDnsAliasAcquire.json | 2 +- .../ServerDnsAliasCreateOrUpdate.json | 2 +- .../examples/ServerDnsAliasDelete.json | 2 +- .../examples/ServerDnsAliasGet.json | 2 +- .../examples/ServerDnsAliasList.json | 2 +- .../examples/UpdateJobAgent.json | 2 +- .../2017-03-01-preview/longTermRetention.json | 1414 +- .../serverAutomaticTuning.json | 604 +- .../ManagedInstanceTdeCertificates.json | 414 +- .../2017-10-01-preview/TdeCertificates.json | 414 +- .../examples/GetShortTermRetentionPolicy.json | 42 +- ...tShortTermRetentionPoliciesByDatabase.json | 50 +- .../ManagedInstanceTdeCertificate.json | 34 +- .../examples/SqlTdeCertificateCreate.json | 36 +- .../UpdateShortTermRetentionPolicy.json | 54 +- .../shortTermRetentionPolicies.json | 796 +- .../examples/ServerAdvisorCreateOrUpdate.json | 54 +- .../stable/2016-11-01/examples/CreateJob.json | 270 +- .../stable/2016-11-01/examples/DeleteJob.json | 110 +- .../stable/2016-11-01/examples/GetJob.json | 114 +- .../2016-11-01/examples/GetLocation.json | 60 +- .../examples/ListBitLockerKeys.json | 38 +- .../examples/ListJobsInResourceGroup.json | 114 +- .../examples/ListJobsInSubscription.json | 240 +- .../2016-11-01/examples/ListLocations.json | 108 +- .../2016-11-01/examples/ListOperations.json | 132 +- .../stable/2016-11-01/examples/UpdateJob.json | 128 +- .../examples/CloudEndpoints_Create.json | 104 +- .../examples/CloudEndpoints_Delete.json | 58 +- .../examples/CloudEndpoints_Get.json | 66 +- .../examples/RegisteredServers_Create.json | 112 +- .../examples/RegisteredServers_Delete.json | 56 +- .../examples/RegisteredServers_Get.json | 68 +- .../examples/ServerEndpoints_Create.json | 104 +- .../examples/ServerEndpoints_Delete.json | 52 +- .../examples/ServerEndpoints_Get.json | 84 +- .../examples/ServerEndpoints_Update.json | 100 +- .../examples/StorageSyncServices_Create.json | 52 +- .../examples/StorageSyncServices_Delete.json | 26 +- .../examples/StorageSyncServices_Get.json | 54 +- .../examples/StorageSyncServices_Update.json | 64 +- .../examples/SyncGroups_Create.json | 52 +- .../examples/SyncGroups_Delete.json | 36 +- .../examples/SyncGroups_Get.json | 50 +- .../examples/Workflows_Get.json | 56 +- .../2017-06-05-preview/storagesync.json | 6474 +- .../examples/EnvironmentsGetExpandStatus.json | 84 +- .../examples/CreateExtensionResource.json | 2 +- .../examples/CreateProjectResource.json | 2 +- .../examples/CreateResource.json | 2 +- .../examples/DeleteExtensionResource.json | 2 +- .../examples/DeleteResource.json | 2 +- .../examples/GetExtensionResource.json | 2 +- .../examples/GetExtensionResources_List.json | 2 +- .../examples/GetOperations.json | 2 +- .../examples/GetProjectJobStatus.json | 2 +- .../examples/GetProjectResource.json | 2 +- .../examples/GetProjectResources_List.json | 2 +- .../examples/GetResource.json | 2 +- .../examples/GetResources_List.json | 2 +- .../examples/UpdateExtensionResource.json | 2 +- .../examples/UpdateProjectResource.json | 2 +- .../examples/CreateExtensionResource.json | 2 +- .../examples/CreateProjectResource.json | 2 +- .../examples/CreateResource.json | 2 +- .../examples/DeleteExtensionResource.json | 2 +- .../examples/DeleteResource.json | 2 +- .../examples/GetExtensionResource.json | 2 +- .../examples/GetExtensionResources_List.json | 2 +- .../examples/GetOperations.json | 2 +- .../examples/GetProjectResource.json | 2 +- .../examples/GetProjectResources_List.json | 2 +- .../examples/GetResource.json | 2 +- .../examples/GetResources_List.json | 2 +- .../examples/UpdateExtensionResource.json | 2 +- .../examples/UpdateProjectResource.json | 2 +- .../examples/CreateProjectResource.json | 2 +- .../examples/GetPipelineTemplates_List.json | 2 +- .../examples/GetProjectResource.json | 2 +- .../examples/GetProjectResources_List.json | 2 +- .../examples/UpdateProjectResource.json | 2 +- 1000 files changed, 154872 insertions(+), 154872 deletions(-) diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json index 4bccf7719005..93c48ce3379d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -1,6371 +1,6371 @@ -{ - "swagger": "2.0", - "info": { - "version": "2014-01-01", - "title": "ADHybridHealthService", - "description": "REST APIs for Azure Active Drectory Connect Health" - }, - "host": "management.azure.com", - "schemes": [ "https" ], - "consumes": [ "application/json" ], - "produces": [ "application/json" ], - "paths": { - "/providers/Microsoft.ADHybridHealthService/addsservices": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.", - "operationId": "addsServices_list", - "x-ms-examples": { - "addsServices_list": { - "$ref": "./examples/Services.json" - } - }, - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The service property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceType", - "in": "query", - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "required": false, - "type": "string" - }, - { - "name": "skipCount", - "in": "query", - "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", - "required": false, - "type": "integer" - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": " The list of Active Directory Domain Controller services.", - "schema": { - "$ref": "#/definitions/Services" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ "Adds" ], - "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", - "operationId": "addsServices_add", - "x-ms-examples": { - "addsServices_add": { - "$ref": "./examples/AddService.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "name": "service", - "in": "body", - "description": "The service object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - ], - "responses": { - "200": { - "description": "Adds the Active Directory Domain Controller Services.", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}": { - "get": { - "tags": [ "Services" ], - "description": "Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_get": { - "$ref": "./examples/Service.json" - } - }, - "operationId": "addsServices_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Active Directory Domain Controller service as specified by the serviceName property. ", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - }, - "delete": { - "tags": [ "Services" ], - "description": "Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_delete": { - "$ref": "./examples/DeleteService.json" - } - }, - "operationId": "addsServices_delete", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service which needs to be deleted.", - "required": true, - "type": "string" - }, - { - "name": "confirm", - "in": "query", - "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Successfully deleted the service." - } - } - }, - "patch": { - "tags": [ "Services" ], - "description": "Updates an Active Directory Domain Service properties of an onboarded service.", - "x-ms-examples": { - "addsServices_update": { - "$ref": "./examples/UpdateService.json" - } - }, - "operationId": "addsServices_update", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service which needs to be deleted.", - "required": true, - "type": "string" - }, - { - "name": "service", - "in": "body", - "description": "The service object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Sucessfully updated service.", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the alerts for a given Active Directory Domain Service.", - "x-ms-examples": { - "alerts_listAddsAlerts": { - "$ref": "./examples/Alerts.json" - } - }, - "operationId": "alerts_listAddsAlerts", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The alert property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "state", - "in": "query", - "description": "The alert state to query for.", - "required": false, - "type": "string" - }, - { - "name": "from", - "in": "query", - "description": "The start date to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "to", - "in": "query", - "description": "The end date till when to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of alerts for the given service.", - "schema": { - "$ref": "#/definitions/Alerts" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the service configurations.", - "x-ms-examples": { - "configuration_listAddsConfigurations": { - "$ref": "./examples/AddsConfiguration.json" - } - }, - "operationId": "configuration_listAddsConfigurations", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "grouping", - "in": "query", - "description": "The grouping for configurations.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The Active Directory Domain Controller service configuration. ", - "schema": { - "$ref": "#/definitions/AddsConfiguration" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the dimensions for a given dimension type in a server.", - "x-ms-examples": { - "dimensions_listAddsDimensions": { - "$ref": "./examples/Dimensions.json" - } - }, - "operationId": "dimensions_listAddsDimensions", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "dimension", - "in": "path", - "description": "The dimension type.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of dimensions for a server. ", - "schema": { - "$ref": "#/definitions/Dimensions" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServiceMembers_list": { - "$ref": "./examples/AddsServiceMembers.json" - } - }, - "operationId": "addsServiceMembers_list", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of Active Directory Domain Servers. ", - "schema": { - "$ref": "#/definitions/AddsServiceMembers" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "adDomainServiceMembers_list": { - "$ref": "./examples/AddomainServiceMembers.json" - } - }, - "operationId": "adDomainServiceMembers_list", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "isGroupbySite", - "in": "query", - "description": "Indicates if the result should be grouped by site or not.", - "required": true, - "type": "boolean" - }, - { - "name": "query", - "in": "query", - "description": "The custom query.", - "required": false, - "type": "string" - }, - { - "name": "nextPartitionKey", - "in": "query", - "description": "The next partition key to query for.", - "required": true, - "type": "string", - "enum": [ " " ], - "x-ms-enum": { - "name": "nextPartitionKey", - "modelAsString": true - } - }, - { - "name": "nextRowKey", - "in": "query", - "description": "The next row key to query for.", - "required": true, - "type": "string", - "enum": [ " " ], - "x-ms-enum": { - "name": "nextRowKey", - "modelAsString": true - } - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of Active Directory Domain Servers.", - "schema": { - "$ref": "#/definitions/AddsServiceMembers" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the user preferences for a given feature.", - "x-ms-examples": { - "addsServicesUserPreference_get": { - "$ref": "./examples/UserPreference.json" - } - }, - "operationId": "addsServicesUserPreference_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "featureName", - "in": "path", - "description": "The name of the feature.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The user preference settings. ", - "schema": { - "$ref": "#/definitions/UserPreference" - } - } - } - }, - "delete": { - "tags": [ "Adds" ], - "description": "Deletes the user preferences for a given feature.", - "x-ms-examples": { - "addsServicesUserPreference_delete": { - "$ref": "./examples/DeleteUserPreference.json" - } - }, - "operationId": "addsServicesUserPreference_delete", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "featureName", - "in": "path", - "description": "The name of the feature.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the user preference settings. " - } - } - }, - "post": { - "tags": [ "Adds" ], - "description": "Adds the user preferences for a given feature.", - "x-ms-examples": { - "addsServicesUserPreference_add": { - "$ref": "./examples/AddUserPreference.json" - } - }, - "operationId": "addsServicesUserPreference_add", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "featureName", - "in": "path", - "description": "The name of the feature.", - "required": true, - "type": "string" - }, - { - "name": "setting", - "in": "body", - "description": "The user preference setting.", - "required": true, - "schema": { - "$ref": "#/definitions/UserPreference" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": " Successfully added the user preference settings. " - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_getForestSummary": { - "$ref": "./examples/ForestSummary.json" - } - }, - "operationId": "addsServices_getForestSummary", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of forest summary for the service. ", - "schema": { - "$ref": "#/definitions/ForestSummary" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the server related metrics for a given metric and group combination.", - "x-ms-examples": { - "addsService_getMetrics": { - "$ref": "./examples/Service_MetricSets.json" - } - }, - "operationId": "addsService_getMetrics", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "name": "groupKey", - "in": "query", - "description": "The group key", - "required": false, - "type": "string" - }, - { - "name": "fromDate", - "in": "query", - "description": "The start date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "toDate", - "in": "query", - "description": "The end date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metric sets for the service. ", - "schema": { - "$ref": "#/definitions/MetricSets" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the average of the metric values for a given metric and group combination.", - "x-ms-examples": { - "addsServices_listMetricsAverage": { - "$ref": "./examples/Metrics.json" - } - }, - "operationId": "addsServices_listMetricsAverage", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of metrics. ", - "schema": { - "$ref": "#/definitions/Metrics" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the sum of the metric values for a given metric and group combination.", - "x-ms-examples": { - "addsServices_listMetricsSum": { - "$ref": "./examples/Metrics.json" - } - }, - "operationId": "addsServices_listMetricsSum", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of aum of the metric values for a given service. ", - "schema": { - "$ref": "#/definitions/Metrics" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the service related metrics information.", - "x-ms-examples": { - "addsServices_listMetricMetadata": { - "$ref": "./examples/MetricMetadataList.json" - } - }, - "operationId": "addsServices_listMetricMetadata", - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The metric metadata property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "perfCounter", - "in": "query", - "description": "Indicates if only performance counter metrics are requested.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of metric metadata for a service. ", - "schema": { - "$ref": "#/definitions/MetricMetadataList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the service related metric information.", - "x-ms-examples": { - "addsServices_getMetricMetadata": { - "$ref": "./examples/MetricMetadata.json" - } - }, - "operationId": "addsServices_getMetricMetadata", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": " The metric metadata for the service.", - "schema": { - "$ref": "#/definitions/MetricMetadata" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the service related metrics for a given metric and group combination.", - "x-ms-examples": { - "addsServices_getMetricMetadataForGroup": { - "$ref": "./examples/MetricSets.json" - } - }, - "operationId": "addsServices_getMetricMetadataForGroup", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "name": "groupKey", - "in": "query", - "description": "The group key", - "required": false, - "type": "string" - }, - { - "name": "fromDate", - "in": "query", - "description": "The start date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "toDate", - "in": "query", - "description": "The end date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metric sets for a given service and group. ", - "schema": { - "$ref": "#/definitions/MetricSets" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails": { - "get": { - "tags": [ "Adds" ], - "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_listReplicationDetails": { - "$ref": "./examples/ReplicationDetails.json" - } - }, - "operationId": "addsServices_listReplicationDetails", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "withDetails", - "in": "query", - "description": "Indicates if InboundReplicationNeighbor details are required or not.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of replication details for a service. ", - "schema": { - "$ref": "#/definitions/ReplicationDetailsList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus": { - "get": { - "tags": [ "Adds" ], - "description": "Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServicesReplicationStatus_get": { - "$ref": "./examples/ReplicationStatus.json" - } - }, - "operationId": "addsServicesReplicationStatus_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The replication status for a service. ", - "schema": { - "$ref": "#/definitions/ReplicationStatus" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary": { - "get": { - "tags": [ "Adds" ], - "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_listReplicationSummary": { - "$ref": "./examples/ReplicationSummary.json" - } - }, - "operationId": "addsServices_listReplicationSummary", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "isGroupbySite", - "in": "query", - "description": "Indicates if the result should be grouped by site or not.", - "required": true, - "type": "boolean" - }, - { - "name": "query", - "in": "query", - "description": "The custom query.", - "required": true, - "type": "string" - }, - { - "name": "nextPartitionKey", - "in": "query", - "description": "The next partition key to query for.", - "required": true, - "type": "string", - "enum": [ " " ], - "x-ms-enum": { - "name": "nextPartitionKey", - "modelAsString": true - } - }, - { - "name": "nextRowKey", - "in": "query", - "description": "The next row key to query for.", - "required": true, - "type": "string", - "enum": [ " " ], - "x-ms-enum": { - "name": "nextRowKey", - "modelAsString": true - } - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of replication summary for a service. ", - "schema": { - "$ref": "#/definitions/ReplicationSummaryList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "addsServicesServiceMembers_list": { - "$ref": "./examples/ServiceMembers.json" - } - }, - "operationId": "addsServicesServiceMembers_list", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "dimensionType", - "in": "query", - "description": "The server specific dimension.", - "required": false, - "type": "string" - }, - { - "name": "dimensionSignature", - "in": "query", - "description": "The value of the dimension.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of service members for a given service.", - "schema": { - "$ref": "#/definitions/ServiceMembers" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ "Adds" ], - "description": "Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "addsServicesServiceMembers_add": { - "$ref": "./examples/AddServiceMembers.json" - } - }, - "operationId": "addsServicesServiceMembers_add", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service under which the server is to be onboarded.", - "required": true, - "type": "string" - }, - { - "name": "serviceMember", - "in": "body", - "description": "The server object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceMember" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully added the service member.", - "schema": { - "$ref": "#/definitions/ServiceMember" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "addsServiceMembers_get": { - "$ref": "./examples/ServiceMember.json" - } - }, - "operationId": "addsServiceMembers_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service member details for a given service. ", - "schema": { - "$ref": "#/definitions/ServiceMember" - } - } - } - }, - "delete": { - "tags": [ "Adds" ], - "description": "Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "addsServiceMembers_delete": { - "$ref": "./examples/DeleteServer.json" - } - }, - "operationId": "addsServiceMembers_delete", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "confirm", - "in": "query", - "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the service member." - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the details of an alert for a given Active Directory Domain Controller service and server combination.", - "x-ms-examples": { - "addsServices_listServerAlerts": { - "$ref": "./examples/Server_Alerts.json" - } - }, - "operationId": "addsServices_listServerAlerts", - "parameters": [ - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id for which the alert details needs to be queried.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The alert property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "state", - "in": "query", - "description": "The alert state to query for.", - "required": false, - "type": "string" - }, - { - "name": "from", - "in": "query", - "description": "The start date to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "to", - "in": "query", - "description": "The end date till when to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of server alerts.", - "schema": { - "$ref": "#/definitions/Alerts" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials": { - "get": { - "tags": [ "Adds" ], - "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "addsServiceMembers_listCredentials": { - "$ref": "./examples/Credentials.json" - } - }, - "operationId": "addsServiceMembers_listCredentials", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of server credentials.", - "schema": { - "$ref": "#/definitions/Credentials" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck": { - "get": { - "tags": [ "Services" ], - "description": "Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "addsServices_listPremiumServices": { - "$ref": "./examples/Services.json" - } - }, - "operationId": "addsServices_listPremiumServices", - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The service property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceType", - "in": "query", - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "required": false, - "type": "string" - }, - { - "name": "skipCount", - "in": "query", - "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", - "required": false, - "type": "integer" - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of premium services.", - "schema": { - "$ref": "#/definitions/Services" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/operations": { - "get": { - "tags": [ - "operations" - ], - "x-ms-examples": { - "operations_list": { - "$ref": "./examples/OperationList.json" - } - }, - "operationId": "operations_list", - "description": "Lists the available Azure Data Factory API operations.", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of operations.", - "schema": { - "$ref": "#/definitions/OperationListResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/configuration": { - "post": { - "tags": [ "Configuration" ], - "description": "Onboards a tenant in Azure Active Directory Connect Health.", - "x-ms-examples": { - "configuration_add": { - "$ref": "./examples/Tenant.json" - } - }, - "operationId": "configuration_add", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully added the tenant.", - "schema": { - "$ref": "#/definitions/Tenant" - } - } - } - }, - "get": { - "tags": [ "Configuration" ], - "description": "Gets the details of a tenant onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "configuration_get": { - "$ref": "./examples/Tenant.json" - } - }, - "operationId": "configuration_get", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The tenant details.", - "schema": { - "$ref": "#/definitions/Tenant" - } - } - } - }, - "patch": { - "tags": [ "Configuration" ], - "description": "Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "configuration_update": { - "$ref": "./examples/PatchTenant.json" - } - }, - "operationId": "configuration_update", - "parameters": [ - { - "name": "tenant", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Tenant" - }, - "description": "The tenant object with the properties set to the updated value." - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the tenant.", - "schema": { - "$ref": "#/definitions/Tenant" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps": { - "get": { - "tags": [ "DevOps" ], - "description": "Checks if the user is enabled for Dev Ops access.", - "x-ms-examples": { - "reports_getDevOps": { - "$ref": "./examples/DevOps.json" - } - }, - "operationId": "reports_getDevOps", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Indicates if the user is Dev Ops or not.", - "schema": { - "$ref": "#/definitions/Result" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services": { - "get": { - "tags": [ "Services" ], - "description": "Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "services_list": { - "$ref": "./examples/Services.json" - } - }, - "operationId": "services_list", - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The service property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceType", - "in": "query", - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "required": false, - "type": "string" - }, - { - "name": "skipCount", - "in": "query", - "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", - "required": false, - "type": "integer" - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of services.", - "schema": { - "$ref": "#/definitions/Services" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ "Services" ], - "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", - "x-ms-examples": { - "services_add": { - "$ref": "./examples/AddService.json" - } - }, - "operationId": "services_add", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "name": "service", - "in": "body", - "description": "The service object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - ], - "responses": { - "200": { - "description": "Successfully added the service.", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/premiumCheck": { - "get": { - "tags": [ "Services" ], - "description": "Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "services_listPremium": { - "$ref": "./examples/Services.json" - } - }, - "operationId": "services_listPremium", - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The service property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceType", - "in": "query", - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "required": false, - "type": "string" - }, - { - "name": "skipCount", - "in": "query", - "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", - "required": false, - "type": "integer" - }, - { - "name": "takeCount", - "in": "query", - "description": "The take count , which specifies the number of elements that can be returned from a sequence.", - "required": false, - "type": "integer" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of premium services.", - "schema": { - "$ref": "#/definitions/Services" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}": { - "get": { - "tags": [ "Services" ], - "description": "Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "services_get": { - "$ref": "./examples/Service.json" - } - }, - "operationId": "services_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of services.", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - }, - "delete": { - "tags": [ "Services" ], - "description": "Deletes a service which is onboarded to Azure Active Directory Connect Health.", - "x-ms-examples": { - "services_delete": { - "$ref": "./examples/DeleteService.json" - } - }, - "operationId": "services_delete", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service which needs to be deleted.", - "required": true, - "type": "string" - }, - { - "name": "confirm", - "in": "query", - "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Successfully deleted the service." - } - } - }, - "patch": { - "tags": [ "Services" ], - "description": "Updates the service properties of an onboarded service.", - "x-ms-examples": { - "services_update": { - "$ref": "./examples/UpdateService.json" - } - }, - "operationId": "services_update", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service which needs to be deleted.", - "required": true, - "type": "string" - }, - { - "name": "service", - "in": "body", - "description": "The service object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the service.", - "schema": { - "$ref": "#/definitions/ServiceProperties" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts": { - "get": { - "tags": [ "Alerts" ], - "description": "Gets the alerts for a given service.", - "x-ms-examples": { - "services_listAlerts": { - "$ref": "./examples/Alerts.json" - } - }, - "operationId": "services_listAlerts", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The alert property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "state", - "in": "query", - "description": "The alert state to query for.", - "required": false, - "type": "string" - }, - { - "name": "from", - "in": "query", - "description": "The start date to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "to", - "in": "query", - "description": "The end date till when to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of alerts.", - "schema": { - "$ref": "#/definitions/Alerts" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}": { - "get": { - "tags": [ "Services" ], - "description": "Checks if the service has all the pre-requisites met to use a feature.", - "x-ms-examples": { - "services_getFeatureAvailibility": { - "$ref": "./examples/CheckFeatureAvailibility.json" - } - }, - "operationId": "services_getFeatureAvailibility", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "featureName", - "in": "path", - "description": "The name of the feature.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Indicates if the feature is available or not.", - "schema": { - "$ref": "#/definitions/Result" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts": { - "get": { - "tags": [ "Services" ], - "description": "Gets the count of latest AAD export errors.", - "x-ms-examples": { - "services_listExportErrors": { - "$ref": "./examples/ErrorCounts.json" - } - }, - "operationId": "services_listExportErrors", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of export errors.", - "schema": { - "$ref": "#/definitions/ErrorCounts" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2": { - "get": { - "tags": [ "Services" ], - "description": " Gets the categorized export errors.", - "x-ms-examples": { - "services_listExportErrorsV2": { - "$ref": "./examples/MergedExportErrors.json" - } - }, - "operationId": "services_listExportErrorsV2", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "errorBucket", - "in": "query", - "description": "The error category to query for.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of merged export errors.", - "schema": { - "$ref": "#/definitions/MergedExportErrors" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus": { - "get": { - "tags": [ "Services" ], - "description": "Gets the export status.", - "x-ms-examples": { - "services_listExportStatus": { - "$ref": "./examples/ExportStatus.json" - } - }, - "operationId": "services_listExportStatus", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of export statuses.", - "schema": { - "$ref": "#/definitions/ExportStatuses" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback": { - "post": { - "tags": [ "Feedback" ], - "description": "Adds an alert feedback submitted by customer.", - "x-ms-examples": { - "services_addAlertFeedback": { - "$ref": "./examples/AddAlertFeedback.json" - } - }, - "operationId": "services_addAlertFeedback", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "alertFeedback", - "in": "body", - "description": "The alert feedback.", - "required": true, - "schema": { - "$ref": "#/definitions/AlertFeedback" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully added alert feedback.", - "schema": { - "$ref": "#/definitions/AlertFeedback" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback": { - "get": { - "tags": [ "Feedback" ], - "description": "Gets a list of all alert feedback for a given tenant and alert type.", - "x-ms-examples": { - "services_listAlertFeedback": { - "$ref": "./examples/GetAlertFeedback.json" - } - }, - "operationId": "services_listAlertFeedback", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "shortName", - "in": "path", - "description": "The name of the alert.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of alert feedback.", - "schema": { - "$ref": "#/definitions/AlertFeedbacks" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the server related metrics for a given metric and group combination.", - "x-ms-examples": { - "service_getMetrics": { - "$ref": "./examples/Service_MetricSets.json" - } - }, - "operationId": "service_getMetrics", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "name": "groupKey", - "in": "query", - "description": "The group key", - "required": false, - "type": "string" - }, - { - "name": "fromDate", - "in": "query", - "description": "The start date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "toDate", - "in": "query", - "description": "The end date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metric sets for a given service.", - "schema": { - "$ref": "#/definitions/MetricSets" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the average of the metric values for a given metric and group combination.", - "x-ms-examples": { - "services_listMetricsAverage": { - "$ref": "./examples/Metrics.json" - } - }, - "operationId": "services_listMetricsAverage", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of average metrics for a given service.", - "schema": { - "$ref": "#/definitions/Metrics" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the sum of the metric values for a given metric and group combination.", - "x-ms-examples": { - "services_listMetricsSum": { - "$ref": "./examples/Metrics.json" - } - }, - "operationId": "services_listMetricsSum", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of metrics for a given service.", - "schema": { - "$ref": "#/definitions/Metrics" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the service related metrics information.", - "x-ms-examples": { - "services_listMetricMetadata": { - "$ref": "./examples/MetricMetadataList.json" - } - }, - "operationId": "services_listMetricMetadata", - "parameters": [ - { - "name": "$filter", - "in": "query", - "description": "The metric metadata property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "perfCounter", - "in": "query", - "description": "Indicates if only performance counter metrics are requested.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of metric metadata for a given service.", - "schema": { - "$ref": "#/definitions/MetricMetadataList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the service related metrics information.", - "x-ms-examples": { - "services_getMetricMetadata": { - "$ref": "./examples/MetricMetadata.json" - } - }, - "operationId": "services_getMetricMetadata", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metric metadata for a given metric.", - "schema": { - "$ref": "#/definitions/MetricMetadata" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the service related metrics for a given metric and group combination.", - "x-ms-examples": { - "services_getMetricMetadataForGroup": { - "$ref": "./examples/MetricSets.json" - } - }, - "operationId": "services_getMetricMetadataForGroup", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "name": "groupKey", - "in": "query", - "description": "The group key", - "required": false, - "type": "string" - }, - { - "name": "fromDate", - "in": "query", - "description": "The start date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "toDate", - "in": "query", - "description": "The end date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The metric sets for a given service and group.", - "schema": { - "$ref": "#/definitions/MetricSets" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration": { - "patch": { - "tags": [ "Services" ], - "description": "Updates the service level monitoring configuration.", - "x-ms-examples": { - "services_updateMonitoringConfiguration": { - "$ref": "./examples/PatchMonitoringConfiguration.json" - } - }, - "operationId": "services_updateMonitoringConfiguration", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "configurationSetting", - "in": "body", - "description": "The monitoring configuration to update", - "required": true, - "schema": { - "$ref": "#/definitions/Item" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the monitoring configuration." - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations": { - "get": { - "tags": [ "Services" ], - "description": "Gets the service level monitoring configurations.", - "x-ms-examples": { - "services_listMonitoringConfigurations": { - "$ref": "./examples/MonitoringConfigurations.json" - } - }, - "operationId": "services_listMonitoringConfigurations", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of monitoring configurations.", - "schema": { - "$ref": "#/definitions/Items" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user": { - "get": { - "tags": [ "Reports" ], - "description": "Gets the bad password login attempt report for an user", - "x-ms-examples": { - "services_listUserBadPasswordReport": { - "$ref": "./examples/BadPasswordDetails.json" - } - }, - "operationId": "services_listUserBadPasswordReport", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "dataSource", - "in": "query", - "description": "The source of data, if its test data or customer data.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of bad password login attempts.", - "schema": { - "$ref": "#/definitions/ErrorReportUsersEntries" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_list": { - "$ref": "./examples/ServiceMembers.json" - } - }, - "operationId": "serviceMembers_list", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The server property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "dimensionType", - "in": "query", - "description": "The server specific dimension.", - "required": false, - "type": "string" - }, - { - "name": "dimensionSignature", - "in": "query", - "description": "The value of the dimension.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of service members.", - "schema": { - "$ref": "#/definitions/ServiceMembers" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - }, - "post": { - "tags": [ "ServiceMembers" ], - "description": "Onboards a server, for a given service, to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_add": { - "$ref": "./examples/AddServiceMembers.json" - } - }, - "operationId": "serviceMembers_add", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service under which the server is to be onboarded.", - "required": true, - "type": "string" - }, - { - "name": "serviceMember", - "in": "body", - "description": "The server object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceMember" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully added the service member.", - "schema": { - "$ref": "#/definitions/ServiceMember" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_get": { - "$ref": "./examples/ServiceMember.json" - } - }, - "operationId": "serviceMembers_get", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The specific service member.", - "schema": { - "$ref": "#/definitions/ServiceMember" - } - } - } - }, - "delete": { - "tags": [ "ServiceMembers" ], - "description": "Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_delete": { - "$ref": "./examples/DeleteServer.json" - } - }, - "operationId": "serviceMembers_delete", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "confirm", - "in": "query", - "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the service member." - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts": { - "get": { - "tags": [ "Alerts" ], - "description": "Gets the details of an alert for a given service and server combination.", - "x-ms-examples": { - "serviceMembers_listAlerts": { - "$ref": "./examples/Server_Alerts.json" - } - }, - "operationId": "serviceMembers_listAlerts", - "parameters": [ - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id for which the laert details needs to be queried.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The alert property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "state", - "in": "query", - "description": "The alert state to query for.", - "required": false, - "type": "string" - }, - { - "name": "from", - "in": "query", - "description": "The start date to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "to", - "in": "query", - "description": "The end date till when to query for.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of alerts.", - "schema": { - "$ref": "#/definitions/Alerts" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the connector details for a service.", - "x-ms-examples": { - "serviceMembers_listConnectors": { - "$ref": "./examples/Connectors.json" - } - }, - "operationId": "serviceMembers_listConnectors", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of connector details.", - "schema": { - "$ref": "#/definitions/Connectors" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_listCredentials": { - "$ref": "./examples/Credentials.json" - } - }, - "operationId": "serviceMembers_listCredentials", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The property filter to apply.", - "required": false, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of service member credentials.", - "schema": { - "$ref": "#/definitions/Credentials" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data": { - "delete": { - "tags": [ "ServiceMembers" ], - "description": "Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_deleteData": { - "$ref": "./examples/DeleteServer.json" - } - }, - "operationId": "serviceMembers_deleteData", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the service member." - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.", - "x-ms-examples": { - "serviceMembers_listDataFreshness": { - "$ref": "./examples/Datafreshness.json" - } - }, - "operationId": "serviceMembers_listDataFreshness", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of datafreshness details for a server.", - "schema": { - "$ref": "#/definitions/DataFreshnessDetails" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the export status.", - "x-ms-examples": { - "serviceMembers_listExportStatus": { - "$ref": "./examples/Server_ExportStatus.json" - } - }, - "operationId": "serviceMembers_listExportStatus", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of export statuses.", - "schema": { - "$ref": "#/definitions/ExportStatuses" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the global configuration.", - "x-ms-examples": { - "serviceMembers_listGlobalConfiguration": { - "$ref": "./examples/GlobalConfiguration.json" - } - }, - "operationId": "serviceMembers_listGlobalConfiguration", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of global configurations.", - "schema": { - "$ref": "#/definitions/GlobalConfigurations" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}": { - "get": { - "tags": [ "Metrics" ], - "description": "Gets the server related metrics for a given metric and group combination.", - "x-ms-examples": { - "serviceMembers_getMetrics": { - "$ref": "./examples/Server_MetricSets.json" - } - }, - "operationId": "serviceMembers_getMetrics", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "metricName", - "in": "path", - "description": "The metric name", - "required": true, - "type": "string" - }, - { - "name": "groupName", - "in": "path", - "description": "The group name", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server id.", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "name": "groupKey", - "in": "query", - "description": "The group key", - "required": false, - "type": "string" - }, - { - "name": "fromDate", - "in": "query", - "description": "The start date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "name": "toDate", - "in": "query", - "description": "The end date.", - "required": false, - "type": "string", - "format": "date-time" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of metric sets for a given metric.", - "schema": { - "$ref": "#/definitions/MetricSets" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration": { - "get": { - "tags": [ "ServiceMembers" ], - "description": "Gets the service configuration.", - "x-ms-examples": { - "serviceMembers_getServiceConfiguration": { - "$ref": "./examples/ServiceConfiguration.json" - } - }, - "operationId": "serviceMembers_getServiceConfiguration", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "serviceMemberId", - "in": "path", - "description": "The server Id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service configuration.", - "schema": { - "$ref": "#/definitions/ServiceConfiguration" - } - } - } - } - }, - "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}": { - "get": { - "tags": [ "Services" ], - "description": "Checks if the tenant, to which a service is registered, is whitelisted to use a feature.", - "x-ms-examples": { - "services_getTenantWhitelisting": { - "$ref": "./examples/TenantWhitelisting.json" - } - }, - "operationId": "services_getTenantWhitelisting", - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service.", - "required": true, - "type": "string" - }, - { - "name": "featureName", - "in": "path", - "description": "The name of the feature.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Indicates if a tenant is whitelisted for a feature or not.", - "schema": { - "$ref": "#/definitions/Result" - } - } - } - } - } - }, - "definitions": { - "AddsConfiguration": { - "description": "The list of key value properties.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "totalCount": { - "description": "The total count of configuration.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "AdditionalInformation": { - "description": "The addtional information for a property.", - "type": "object", - "properties": { - "titleName": { - "description": "The title name for the property.", - "type": "string" - }, - "titleValue": { - "description": "The title value for the property.", - "type": "string" - }, - "properties": { - "description": "The list of properties which are included in the aditional information.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "hasProperties": { - "description": "Indicates if properties are present or not.", - "type": "boolean" - } - } - }, - "AddsServiceMember": { - "description": "The server details for ADDS service.", - "type": "object", - "properties": { - "domainName": { - "description": "The domain name.", - "type": "string" - }, - "siteName": { - "description": "The site name.", - "type": "string" - }, - "addsRoles": { - "description": "The list of ADDS roles.", - "type": "array", - "items": { - "type": "string" - } - }, - "gcReachable": { - "description": "Indicates if the global catalog for this domain is reachable or not.", - "type": "boolean" - }, - "isAdvertising": { - "description": "Indicates if the Dc is advertising or not.", - "type": "boolean" - }, - "pdcReachable": { - "description": "Indicates if the primary domain controller is reachable or not.", - "type": "boolean" - }, - "sysvolState": { - "description": "Indicates if the SYSVOL state is healthy or not.", - "type": "boolean" - }, - "dcTypes": { - "description": "The list of domain controller types.", - "type": "array", - "items": { - "type": "string" - } - }, - "serviceMemberId": { - "description": "The id of the server.", - "type": "string" - }, - "serviceId": { - "description": "The service id to whom this server belongs.", - "type": "string" - }, - "tenantId": { - "description": "The tenant id to whom this server belongs.", - "type": "string" - }, - "activeAlerts": { - "description": "The total number of alerts that are currently active for the server.", - "type": "integer" - }, - "additionalInformation": { - "description": "The additional information, if any, for the server.", - "type": "string" - }, - "createdDate": { - "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", - "type": "string", - "format": "date-time" - }, - "dimensions": { - "description": "The server specific configuration related dimensions.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "disabled": { - "description": "Indicates if the server is disabled or not. ", - "type": "boolean" - }, - "disabledReason": { - "description": "The reason for disabling the server.", - "type": "integer" - }, - "installedQfes": { - "description": "The list of installed QFEs for the server.", - "type": "array", - "items": { - "$ref": "#/definitions/Hotfix" - } - }, - "lastDisabled": { - "description": "The date and time , in UTC, when the server was last disabled.", - "type": "string", - "format": "date-time" - }, - "lastReboot": { - "description": "The date and time, in UTC, when the server was last rebooted.", - "type": "string", - "format": "date-time" - }, - "lastServerReportedMonitoringLevelChange": { - "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", - "type": "string", - "format": "date-time" - }, - "lastUpdated": { - "description": "The date and time, in UTC, when the server proeprties were last updated.", - "type": "string", - "format": "date-time" - }, - "machineId": { - "description": "The id of the machine.", - "type": "string" - }, - "machineName": { - "description": "The name of the server.", - "type": "string" - }, - "monitoringConfigurationsComputed": { - "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "monitoringConfigurationsCustomized": { - "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "osName": { - "description": "The name of the operating system installed in the machine.", - "type": "string" - }, - "osVersion": { - "description": "The version of the operating system installed in the machine.", - "type": "string" - }, - "properties": { - "description": "Server specific properties.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "recommendedQfes": { - "description": "The list of recommended hotfixes for the server.", - "type": "array", - "items": { - "$ref": "#/definitions/Hotfix" - } - }, - "resolvedAlerts": { - "description": "The total count of alerts that are resolved for this server.", - "type": "integer" - }, - "role": { - "description": "The service role that is being monitored in the server.", - "type": "string" - }, - "serverReportedMonitoringLevel": { - "description": "The monitoring level reported by the server.", - "type": "string", - "enum": [ - "Partial", - "Full", - "Off" - ], - "x-ms-enum": { - "name": "MonitoringLevel", - "modelAsString": false - } - }, - "status": { - "description": "The health status of the server.", - "type": "string" - } - } - }, - "AddsServiceMembers": { - "description": "The list of ADDS service members.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/AddsServiceMember" - } - }, - "totalCount": { - "description": "The total count of service members.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "Agent": { - "description": "The agent details.", - "type": "object", - "properties": { - "tenantId": { - "description": "The tenant Id.", - "type": "string" - }, - "machineId": { - "description": "The machine Id.", - "type": "string" - }, - "credential": { - "description": "The agent credential details.", - "type": "object", - "items": { - "$ref": "#/definitions/Credential" - } - }, - "machineName": { - "description": "The machine name.", - "type": "string" - }, - "agentVersion": { - "description": "The agent version.", - "type": "string" - }, - "createdDate": { - "description": "The date and time, in UTC, when the agent was created.", - "type": "string", - "format": "date-time" - }, - "key": { - "description": " The connector hash key.", - "type": "string" - } - } - }, - "Alert": { - "description": " The alert details indicating an issue with service or server.", - "type": "object", - "properties": { - "alertId": { - "description": "The alert Id.", - "type": "string", - "format": "uuid" - }, - "level": { - "description": "The alert level which indicates the severity of the alert.", - "type": "string", - "enum": [ - "Warning", - "Error", - "PreWarning" - ], - "x-ms-enum": { - "name": "Level", - "modelAsString": true - } - }, - "state": { - "description": "The alert state which can be either active or resolved with multile resolution types.", - "type": "string", - "enum": [ - "Active", - "ResolvedByPositiveResult", - "ResolvedManually", - "ResolvedByTimer", - "ResolvedByStateChange" - ], - "x-ms-enum": { - "name": "State", - "modelAsString": true - } - }, - "shortName": { - "description": "The alert short name.", - "type": "string" - }, - "displayName": { - "description": "The display name for the alert.", - "type": "string" - }, - "description": { - "description": "The alert description.", - "type": "string" - }, - "remediation": { - "description": "The alert remediation.", - "type": "string" - }, - "relatedLinks": { - "description": "The help links to get more information related to the alert.", - "type": "array", - "items": { - "$ref": "#/definitions/HelpLink" - } - }, - "scope": { - "description": "The scope of the alert. Indicates if it is a service or a server related alert.", - "type": "string" - }, - "additionalInformation": { - "description": "Additional information related to the alert.", - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalInformation" - } - }, - "createdDate": { - "description": "The date and time,in UTC,when the alert was created.", - "type": "string", - "format": "date-time" - }, - "resolvedDate": { - "description": "The date and time, in UTC, when the alert was resolved.", - "type": "string", - "format": "date-time" - }, - "lastUpdated": { - "description": "The date and time, in UTC, when the alert was last updated.", - "type": "string", - "format": "date-time" - }, - "monitorRoleType": { - "description": "The monitoring role type for which the alert was raised.", - "type": "string" - }, - "activeAlertProperties": { - "description": "The active alert properties.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "resolvedAlertProperties": { - "description": "The resolved alert properties.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "tenantId": { - "description": "The tenant Id.", - "type": "string", - "format": "uuid" - }, - "serviceId": { - "description": "The service Id.", - "type": "string", - "format": "uuid" - }, - "serviceMemberId": { - "description": "The server Id.", - "type": "string", - "format": "uuid" - } - } - }, - "AlertFeedback": { - "description": "The alert feedback details.", - "type": "object", - "properties": { - "level": { - "description": "The alert level which indicates the severity of the alert.", - "type": "string" - }, - "state": { - "description": "The alert state which can be either active or resolved with multile resolution types.", - "type": "string" - }, - "shortName": { - "description": "The alert short name.", - "type": "string" - }, - "feedback": { - "description": "The feedback for the alert which indicates if the customer likes or dislikes the alert.", - "type": "string" - }, - "comment": { - "description": "Additional comments related to the alert.", - "type": "string" - }, - "consentedToShare": { - "description": "Indicates if the alert feedback can be shared from product team.", - "type": "boolean" - }, - "serviceMemberId": { - "description": "The server Id of the alert.", - "type": "string" - }, - "createdDate": { - "description": "The date and time,in UTC,when the alert was created.", - "type": "string", - "format": "date-time" - } - } - }, - "AlertFeedbacks": { - "description": "The list of alert feedback.", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The value returned by the operation.", - "items": { - "$ref": "#/definitions/AlertFeedback" - } - } - } - }, - "Alerts": { - "description": "The list of alerts for a service.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Alert" - } - }, - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "totalCount": { - "description": "The total count of alert elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "AssociatedObject": { - "description": "Object that hold sync object details.", - "type": "object", - "properties": { - "displayName": { - "description": "The display name of the object.", - "type": "string" - }, - "distinguishedName": { - "description": "The distinguished name of the object.", - "type": "string" - }, - "lastDirSyncTime": { - "description": "The last dirSync time.", - "type": "string", - "format": "date-time" - }, - "mail": { - "description": "The email of the object.", - "type": "string" - }, - "objectGuid": { - "description": "The object guid.", - "type": "string" - }, - "objectType": { - "description": "The object type.", - "type": "string" - }, - "onpremisesUserPrincipalName": { - "description": "The On-premises UPN.", - "type": "string" - }, - "proxyAddresses": { - "description": "The proxy addresses.", - "type": "string" - }, - "sourceAnchor": { - "description": "The source anchor.", - "type": "string" - }, - "sourceOfAuthority": { - "description": "The source of authority.", - "type": "string" - }, - "timeOccurred": { - "description": " The time of the error.", - "type": "string", - "format": "date-time" - }, - "userPrincipalName": { - "description": " The UPN.", - "type": "string" - } - } - }, - "AttributeDelta": { - "description": "The delta attributes.", - "type": "object", - "properties": { - "values": { - "description": "The delta values.", - "type": "array", - "items": { - "$ref": "#/definitions/ValueDelta" - } - }, - "name": { - "description": "The name of the attribute delta.", - "type": "string" - }, - "operationType": { - "description": "The attribute delta operation type.", - "type": "string", - "enum": [ - "Undefined", - "Add", - "Replace", - "Update", - "Delete" - ], - "x-ms-enum": { - "name": "AttributeDeltaOperationType", - "modelAsString": true - } - }, - "valueType": { - "description": "The value type.", - "type": "string", - "enum": [ - "Undefined", - "Dn", - "Binary", - "String", - "Integer", - "Boolean" - ], - "x-ms-enum": { - "name": "ValueType", - "modelAsString": true - } - }, - "multiValued": { - "description": "Indicates if the attribute delta is multivalued or not.", - "type": "boolean" - } - } - }, - "AttributeMapping": { - "description": "The attribute mapping details.", - "type": "object", - "properties": { - "mappingSource": { - "description": "The mapping source.", - "$ref": "#/definitions/AttributeMppingSource" - }, - "type": { - "description": "The attribute mapping type.", - "type": "string", - "enum": [ - "Constant", - "Direct", - "DnPart", - "Script" - ], - "x-ms-enum": { - "name": "AttributeMappingType", - "modelAsString": true - } - }, - "destinationAttribute": { - "description": "The destination attribute.", - "type": "string" - }, - "contextId": { - "description": "The context Id.", - "type": "string" - } - } - }, - "AttributeMppingSource": { - "description": "The attribute mapping source.", - "type": "object", - "properties": { - "sourceAttribute": { - "description": "The source attribute.", - "type": "array", - "items": { - "type": "string" - } - }, - "dnPart": { - "description": "The value for dn part.", - "type": "integer" - }, - "scriptContext": { - "description": "The script context.", - "type": "string" - }, - "constantValue": { - "description": "The constant value.", - "type": "string" - } - } - }, - "ChangeNotReimported": { - "description": "The changes which are not re-imported.", - "type": "object", - "properties": { - "delta": { - "description": "The delta changes that is not re-imported.", - "$ref": "#/definitions/ChangeNotReimportedDelta" - }, - "entry": { - "description": "The object entry in a change that is not re-imported.", - "$ref": "#/definitions/ChangeNotReimportedEntry" - } - } - }, - "ChangeNotReimportedDelta": { - "description": "The delta in a change that is not re-imported.", - "type": "object", - "properties": { - "anchor": { - "description": "The anchor.", - "type": "string" - }, - "dnAttributes": { - "description": "The delta attributes for distinguished names.", - "type": "array", - "items": { - "$ref": "#/definitions/AttributeDelta" - } - }, - "attributes": { - "description": "The attributes.", - "type": "array", - "items": { - "$ref": "#/definitions/AttributeDelta" - } - }, - "operationType": { - "description": "The operation type.", - "type": "string", - "enum": [ - "Undefined", - "None", - "Add", - "Replace", - "Update", - "Delete", - "Obsolete", - "DeletAdd" - ], - "x-ms-enum": { - "name": "DeltaOperationType", - "modelAsString": true - } - } - } - }, - "ChangeNotReimportedEntry": { - "description": "The object entry in a change that is not re-imported.", - "type": "object", - "properties": { - "anchor": { - "description": "The anchor.", - "type": "string" - }, - "parentAnchor": { - "description": "The parent anchor.", - "type": "string" - }, - "primaryObjectClass": { - "description": "The primary object class.", - "type": "string" - }, - "objectClasses": { - "description": "The olist of object classes.", - "type": "array", - "items": { - "type": "string" - } - }, - "dnAttributes": { - "description": "The delta attributes for distinguished names.", - "type": "array", - "items": { - "$ref": "#/definitions/AttributeDelta" - } - }, - "attributes": { - "description": "The attributes.", - "type": "array", - "items": { - "$ref": "#/definitions/AttributeDelta" - } - }, - "dn": { - "description": "The distinguished name.", - "type": "string" - } - } - }, - "Connector": { - "description": "The connect details.", - "type": "object", - "properties": { - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "id": { - "description": "The connector Id.", - "type": "string" - }, - "name": { - "description": "The connector name.", - "type": "string" - }, - "version": { - "description": "The connector version", - "type": "integer" - }, - "type": { - "description": "The connector type.", - "type": "string" - }, - "description": { - "description": "The connector description.", - "type": "string" - }, - "schemaXml": { - "description": "The schema xml for the connector.", - "type": "string" - }, - "passwordManagementSettings": { - "description": "The password management settings of the connector.", - "type": "object", - "items": { - "$ref": "#/definitions/PasswordManagementSettings" - } - }, - "passwordHashSyncConfiguration": { - "description": "The password hash synchronization configuration of the connector.", - "type": "object", - "items": { - "$ref": "#/definitions/PasswordHashSyncConfiguration" - } - }, - "timeCreated": { - "description": "The date and time when this connector was created.", - "type": "string", - "format": "date-time" - }, - "timeLastModified": { - "description": "The date and time when this connector was last modified.", - "type": "string", - "format": "date-time" - }, - "partitions": { - "description": "The partitions of the connector.", - "type": "array", - "items": { - "$ref": "#/definitions/Partition" - } - }, - "runProfiles": { - "description": "The run profiles of the connector.", - "type": "array", - "items": { - "$ref": "#/definitions/RunProfile" - } - }, - "classesIncluded": { - "description": "The class inclusion list of the connector.", - "type": "array", - "items": { - "type": "string" - } - }, - "attributesIncluded": { - "description": "The attribute inclusion list of the connector.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "Connectors": { - "description": "The list of connects for a service.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Connector" - } - } - } - }, - "ConnectorConnectionError": { - "description": "The connector connection error.", - "type": "object", - "properties": { - "id": { - "description": "The error Id.", - "type": "string" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string" - }, - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "type": { - "description": "The type of error.", - "type": "string" - }, - "errorCode": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The message for the connection error.", - "type": "string" - }, - "timeOccured": { - "description": "The time when the connection error occured.", - "type": "string", - "format": "date-time" - }, - "server": { - "description": "The server where the connection error happened.", - "type": "string" - } - } - }, - "ConnectorConnectionErrors": { - "description": "The list of connector connection errors.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConnectorConnectionError" - } - } - } - }, - "ConnectorObjectError": { - "description": "The connector object error.", - "type": "object", - "properties": { - "id": { - "description": "The error Id.", - "type": "string" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string" - }, - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "type": { - "description": "The type of error.", - "type": "string" - }, - "errorCode": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The message for the object error.", - "type": "string" - }, - "entryNumber": { - "description": "The entry number for object error occured.", - "type": "integer" - }, - "lineNumber": { - "description": "The line number for the object error.", - "type": "integer" - }, - "columnNumber": { - "description": "The column number for the object error.", - "type": "integer" - }, - "dn": { - "description": "The distingished name of the object.", - "type": "string" - }, - "anchor": { - "description": "The name for the anchor of the object.", - "type": "string" - }, - "attributeName": { - "description": "The attribute name of the object.", - "type": "string" - }, - "serverErrorDetail": { - "description": "The server side error details.", - "type": "string" - }, - "values": { - "description": "The value corresponding to attribute name.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ConnectorObjectErrors": { - "description": "The list of connector object errors.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConnectorObjectError" - } - } - } - }, - "Credential": { - "description": "The credential for a given server.", - "type": "object", - "properties": { - "identifier": { - "description": "The credential identifier.", - "type": "string" - }, - "type": { - "description": "The type of credential.", - "type": "string" - }, - "credentialData": { - "description": "The credential data.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "Credentials": { - "description": "The list of agent credentials.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Credential" - } - } - } - }, - "DataFreshnessDetails": { - "description": "The data freshness details for the server.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - } - } - }, - "Dimension": { - "description": "The connector object error.", - "type": "object", - "properties": { - "health": { - "description": "The health status for the domain controller.", - "type": "string", - "enum": [ - "Healthy", - "Warning", - "Error", - "NotMonitored", - "Missing" - ], - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": true - } - }, - "simpleProperties": { - "description": "List of service specific configuration properties.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "activeAlerts": { - "description": "The count of alerts that are currently active for the service.", - "type": "integer" - }, - "additionalInformation": { - "description": "The additional information related to the service.", - "type": "string" - }, - "lastUpdated": { - "description": "The date or time , in UTC, when the service properties were last updated.", - "type": "string", - "format": "date-time" - }, - "displayName": { - "description": "The display name of the service.", - "type": "string" - }, - "resolvedAlerts": { - "description": "The total count of alerts that has been resolved for the service.", - "type": "integer" - }, - "signature": { - "description": "The signature of the service.", - "type": "string" - }, - "type": { - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "type": "string" - } - } - }, - "Dimensions": { - "description": "The list of dimensions.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Dimension" - } - }, - "totalCount": { - "description": "The total count of dimensions.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "Display": { - "description": "Displays the details related to operations supported by Azure Active Directory Connect Health.", - "type": "object", - "properties": { - "description": { - "description": " The description for the operation.", - "type": "string" - }, - "operation": { - "description": "The details of the operation.", - "type": "string" - }, - "provider": { - "description": "The provider name.", - "type": "string" - } - } - }, - "ErrorCount": { - "description": "The error count details.", - "type": "object", - "properties": { - "errorBucket": { - "description": "The error bucket.", - "type": "string" - }, - "count": { - "description": "The error count.", - "type": "integer" - }, - "truncated": { - "description": "Indicates if the error count is truncated or not.", - "type": "boolean" - } - } - }, - "ErrorCounts": { - "description": "The list of error counts.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorCount" - } - } - } - }, - "ErrorDetail": { - "description": "The error details.", - "type": "object", - "properties": { - "description": { - "description": "The error description.", - "type": "string" - }, - "kbUrl": { - "description": "The knowledge base article url which contains more information about the error.", - "type": "string" - }, - "detail": { - "description": "Additional details related to the error.", - "type": "string" - }, - "objectsWithSyncError": { - "description": "The list of objects with sync errors.", - "$ref": "#/definitions/ObjectWithSyncError" - }, - "objectWithSyncError": { - "description": " The object with sync error.", - "$ref": "#/definitions/MergedExportError" - } - } - }, - "ExportError": { - "description": "The export error details.", - "type": "object", - "properties": { - "id": { - "description": "The error Id.", - "type": "string" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string" - }, - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "type": { - "description": "The type of error.", - "type": "string" - }, - "errorCode": { - "description": "The error code.", - "type": "string" - }, - "message": { - "description": "The export error message.", - "type": "string" - }, - "serverErrorDetail": { - "description": "The server error detail.", - "type": "string" - }, - "timeFirstOccured": { - "description": "The date and time when the export error first occured.", - "type": "string", - "format": "date-time" - }, - "retryCount": { - "description": "The retry count.", - "type": "integer" - }, - "csObjectId": { - "description": "The cloud object Id.", - "type": "string" - }, - "dn": { - "description": "The distinguished name.", - "type": "string" - }, - "minLimit": { - "description": "The minimum limit.", - "type": "string" - }, - "maxLimit": { - "description": "The maximum limit.", - "type": "string" - }, - "cloudAnchor": { - "description": "The name of the cloud anchor.", - "type": "string" - }, - "attributeName": { - "description": "The attribute name.", - "type": "string" - }, - "attributeValue": { - "description": "The attribute value.", - "type": "string" - }, - "attributeMultiValue": { - "description": "Indicates if the attribute is multi valued or not.", - "type": "boolean" - }, - "objectIdConflict": { - "description": "The object Id with which there was an attribute conflict.", - "type": "string" - }, - "samAccountName": { - "description": "The SAM account name.", - "type": "string" - }, - "adObjectType": { - "description": "The AD object type", - "type": "string" - }, - "adObjectGuid": { - "description": "The AD object guid.", - "type": "string" - }, - "adDisplayName": { - "description": "The display name for the AD object.", - "type": "string" - }, - "adSourceOfAuthority": { - "description": "The source of authority for the AD object.", - "type": "string" - }, - "adSourceAnchor": { - "description": "The AD source anchor.", - "type": "string" - }, - "adUserPrincipalName": { - "description": "The user principal name for the AD object.", - "type": "string" - }, - "adDistinguishedName": { - "description": "The distinguished name for the AD object.", - "type": "string" - }, - "adMail": { - "description": "The email for the AD object.", - "type": "string" - }, - "timeOccured": { - "description": "The date and time of occurance.", - "type": "string", - "format": "date-time" - }, - "aadObjectType": { - "description": "The AAD side object type.", - "type": "string" - }, - "aadObjectGuid": { - "description": "The AAD side object guid.", - "type": "string" - }, - "aadDisplayName": { - "description": "The AAD side display name", - "type": "string" - }, - "aadSourceOfAuthority": { - "description": "The AAD side source of authority for the object.", - "type": "string" - }, - "aadUserPrincipalName": { - "description": "The AAD side user principal name.", - "type": "string" - }, - "aadDistringuishedName": { - "description": "The AAD side distinguished name for the object.", - "type": "string" - }, - "aadMail": { - "description": "The AAD side email for the object.", - "type": "string" - }, - "lastDirSyncTime": { - "description": "The date and time of last sync run.", - "type": "string", - "format": "date-time" - }, - "modifiedAttributeValue": { - "description": "The modified atttribute value.", - "type": "string" - } - } - }, - "ExportErrors": { - "description": "The list of export errors.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ExportError" - } - } - } - }, - "ErrorReportUsersEntry": { - "description": "The bad password login attempt details.", - "type": "object", - "properties": { - "userId": { - "description": "The user ID value.", - "type": "string" - }, - "ipAddress": { - "description": "The Ip address corresponding to the last error event.", - "type": "string" - }, - "lastUpdated": { - "description": "The date and time when the last error event was logged.", - "type": "string", - "format": "date-time" - }, - "uniqueIpAddresses": { - "description": "The list of unique IP addresses.", - "type": "string" - }, - "totalErrorAttempts": { - "description": "The total count of specific error events.", - "type": "integer" - } - } - }, - "ErrorReportUsersEntries": { - "description": "The list of bad password log in attempt entries.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorReportUsersEntry" - } - } - } - }, - "ExportStatus": { - "description": "The details of the export status.", - "type": "object", - "properties": { - "serviceId": { - "description": "The id of the service for whom the export status is being reported.", - "type": "string", - "format": "uuid" - }, - "serviceMemberId": { - "description": "The server Id for whom the export status is being reported.", - "type": "string", - "format": "uuid" - }, - "endTime": { - "description": "The date and time when the export ended.", - "type": "string", - "format": "date-time" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string" - } - } - }, - "ExportStatuses": { - "description": "The list of export statuses.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ExportStatus" - } - }, - "totalCount": { - "description": "The total count of service elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "ExtensionErrorInfo": { - "description": "The extension error details.", - "type": "object", - "properties": { - "extensionName": { - "description": "The extension name.", - "type": "string" - }, - "extensionContext": { - "description": "The extension context.", - "type": "string" - }, - "callStack": { - "description": "The call stack for the error.", - "type": "string" - } - } - }, - "ForestSummary": { - "description": "The forest summary for an ADDS domain.", - "type": "object", - "properties": { - "forestName": { - "description": "The forest name.", - "type": "string" - }, - "domainCount": { - "description": "The domain count.", - "type": "integer" - }, - "siteCount": { - "description": "The site count.", - "type": "integer" - }, - "monitoredDcCount": { - "description": "The number of domain controllers that are monitored by Azure Active Directory Connect Health.", - "type": "integer" - }, - "totalDcCount": { - "description": "The total domain controllers.", - "type": "integer" - }, - "domains": { - "description": "The list of domain controller names.", - "type": "array", - "items": { - "type": "string" - } - }, - "sites": { - "description": "The list of site names.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "GlobalConfiguration": { - "description": "The global configuration settings.", - "type": "object", - "properties": { - "version": { - "description": "The version for the global configuration.", - "type": "integer" - }, - "schemaXml": { - "description": "The schema for the configuration.", - "type": "string" - }, - "passwordSyncEnabled": { - "description": "Indicates if password sync is enabled or not.", - "type": "boolean" - }, - "numSavedPwdEvent": { - "description": "The number of saved password events.", - "type": "integer" - }, - "featureSet": { - "description": "The list of additional feature sets.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - } - } - }, - "GlobalConfigurations": { - "description": "The list of global configurations.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/GlobalConfiguration" - } - } - } - }, - "HelpLink": { - "description": "The help link which contains more information related to an alert.", - "type": "object", - "properties": { - "title": { - "description": "The title for the link.", - "type": "string" - }, - "url": { - "description": "The url for the help document.", - "type": "string" - } - } - }, - "Hotfix": { - "description": "The details of the hotfix installed in the server.", - "type": "object", - "properties": { - "kbName": { - "description": "The name of the hotfix KB.", - "type": "string" - }, - "link": { - "description": "The link to the KB Article.", - "type": "string" - }, - "installedDate": { - "description": "The date and time, in UTC, when the KB was installed in the server.", - "type": "string", - "format": "date-time" - } - } - }, - "Hotfixes": { - "description": "The list of hotfixes installed in the server.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Hotfix" - } - } - } - }, - "ImportErrors": { - "description": "The list of import errors.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ImportError" - } - } - } - }, - "ImportError": { - "description": "The import error details.", - "type": "object", - "properties": { - "id": { - "description": "The error Id.", - "type": "string" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string" - }, - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "type": { - "description": "The type of error.", - "type": "string" - }, - "timeOccurred": { - "description": "The time when the import error occurred.", - "type": "string", - "format": "date-time" - }, - "timeFirstOccurred": { - "description": "The time when the import error first occurred.", - "type": "string", - "format": "date-time" - }, - "retryCount": { - "description": "The retry count.", - "type": "integer" - }, - "algorithmStepType": { - "description": "The operation type specific to error reporting.", - "type": "string", - "enum": [ - "Undefined", - "Staging", - "ConnectorFilter", - "Join", - "Projection", - "ImportFlow", - "Provisioning", - "ValidateConnectorFilter", - "Deprovisioning", - "ExportFlow", - "MvDeletion", - "Recall", - "MvObjectTypeChange" - ], - "x-ms-enum": { - "name": "AlgorithmStepType", - "modelAsString": true - } - }, - "changeNotReimported": { - "description": "The change details that is not re-imported.", - "$ref": "#/definitions/ChangeNotReimported" - }, - "extensionErrorInfo": { - "description": "The extension error information.", - "$ref": "#/definitions/ExtensionErrorInfo" - }, - "ruleErrorInfo": { - "description": "The error details in legacy rule processing.", - "$ref": "#/definitions/RuleErrorInfo" - }, - "csObjectId": { - "description": "The object Id.", - "type": "string" - }, - "dn": { - "description": "The distinguished name.", - "type": "string" - } - } - }, - "InboundReplicationNeighbor": { - "description": "The replication summary for the domain controller inbound neighbor.", - "type": "object", - "properties": { - "sourceDomainController": { - "description": "The name of the source domain controller.", - "type": "string" - }, - "consecutiveFailureCount": { - "description": "The number of consecutive faulire counts.", - "type": "integer" - }, - "namingContext": { - "description": "The naming context.", - "type": "string" - }, - "status": { - "description": "The health status for the domain controller", - "type": "integer" - }, - "lastAttemptedSync": { - "description": "The last time a sync was attempted on the domain controller.", - "type": "string", - "format": "date-time" - }, - "lastSuccessfulSync": { - "description": "The last time when a successful sync happened.", - "type": "string", - "format": "date-time" - }, - "lastErrorCode": { - "description": "The last error code.", - "type": "integer" - }, - "lastErrorMessage": { - "description": "The error message of the last error.", - "type": "string" - }, - "errorTitle": { - "description": "The error title.", - "type": "string" - }, - "errorDescription": { - "description": "The error description.", - "type": "string" - }, - "fixLink": { - "description": "The link for the fix of the error.", - "type": "string" - }, - "fixDetails": { - "description": "The details of the fix.", - "type": "string" - }, - "additionalInfo": { - "description": "The additional details.", - "type": "string" - } - } - }, - "InboundReplicationNeighbors": { - "description": "The list of replication summary for the domain controller inbound neighbor.", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The details of inbound replication neighbors.", - "items": { - "$ref": "#/definitions/InboundReplicationNeighbor" - } - } - } - }, - "Item": { - "description": "The key value pair for properties.", - "type": "object", - "properties": { - "key": { - "description": "The key for the property.", - "type": "string" - }, - "value": { - "description": "The value for the key.", - "type": "string" - } - } - }, - "Items": { - "description": "The list of key value properties.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - } - } - }, - "MergedExportError": { - "description": "The merged export error.", - "type": "object", - "properties": { - "id": { - "description": "The error Id.", - "type": "string" - }, - "incomingObjectDisplayName": { - "description": "The incoming object display name.", - "type": "string" - }, - "incomingObjectType": { - "description": "The incoming object type.", - "type": "string" - }, - "userPrincipalName": { - "description": "The user principal name", - "type": "string" - }, - "type": { - "description": "The type of the error.", - "type": "string" - }, - "attributeName": { - "description": "The attribute name.", - "type": "string" - }, - "attributeValue": { - "description": "The attribute value.", - "type": "string" - }, - "timeOccurred": { - "description": "The date and time when the error occurred.", - "type": "string", - "format": "date-time" - }, - "timeFirstOccurred": { - "description": "The time when the error first occurred.", - "type": "string", - "format": "date-time" - }, - "csObjectId": { - "description": " the cs object Id.", - "type": "string" - }, - "dn": { - "description": "the DN of the object.", - "type": "string" - }, - "incomingObject": { - "description": "The incoming object details.", - "$ref": "#/definitions/AssociatedObject" - }, - "existingObject": { - "description": "The existing object", - "$ref": "#/definitions/AssociatedObject" - }, - "modifiedOrRemovedAttributeValue": { - "description": "The modified or removed attribute vlaue.", - "type": "string" - }, - "runStepResultId": { - "description": "The run step result Id.", - "type": "string", - "format": "uuid" - }, - "samAccountName": { - "description": "The sam account name.", - "type": "string" - }, - "serverErrorDetail": { - "description": "The server error details.", - "type": "string" - }, - "serviceId": { - "description": "The service Id.", - "type": "string", - "format": "uuid" - }, - "serviceMemberId": { - "description": "The server Id.", - "type": "string", - "format": "uuid" - }, - "mergedEntityId": { - "description": "The merged entity Id.", - "type": "string", - "format": "uuid" - }, - "createdDate": { - "description": "The date and time, in UTC, when the error was created.", - "type": "string", - "format": "date-time" - }, - "exportErrorStatus": { - "description": "The export error status.", - "type": "integer" - } - } - }, - "MergedExportErrors": { - "description": "The list of export errors.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/MergedExportError" - } - } - } - }, - "MetricGroup": { - "description": " The metric group details.", - "type": "object", - "properties": { - "key": { - "description": "The key for the group.", - "type": "string" - }, - "displayName": { - "description": "The display name for the group.", - "type": "string" - }, - "invisibleForUi": { - "description": "indicates if the metric group is displayed in Azure Active Directory Connect Health UI.", - "type": "boolean" - } - } - }, - "Metrics": { - "description": "The list of metric items.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/Item" - } - }, - "totalCount": { - "description": "The total count of metrics.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "MetricMetadata": { - "description": "The metric meta data", - "type": "object", - "properties": { - "metricsProcessorClassName": { - "description": "The name of the class which retrieve and process the metric.", - "type": "string" - }, - "metricName": { - "description": "The metric name", - "type": "string" - }, - "groupings": { - "description": "The groupings for the metrics.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricGroup" - } - }, - "displayName": { - "description": "The display name for the metric.", - "type": "string" - }, - "valueKind": { - "description": "Indicates if the metrics is a rate,value, percent or duration type.", - "type": "string" - }, - "minValue": { - "description": "The minimun value.", - "type": "integer" - }, - "maxValue": { - "description": "The maximum value.", - "type": "integer" - }, - "kind": { - "description": "Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.", - "type": "string" - }, - "isDefault": { - "description": "Indicates if the metric is a default metric or not.", - "type": "boolean" - }, - "isPerfCounter": { - "description": "Indicates if the metric is a performance counter metric or not.", - "type": "boolean" - }, - "isDevOps": { - "description": "Indicates if the metric is visible to DevOps or not.", - "type": "boolean" - } - } - }, - "MetricMetadataList": { - "description": "The list of metric metadata.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricMetadata" - } - }, - "totalCount": { - "description": "The total count of service elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "MetricSet": { - "description": " The set of metric values. Example of a MetricSet are Values of token requests for a Server1 or RelyingParty1.", - "type": "object", - "properties": { - "setName": { - "description": "The name of the set.", - "type": "string" - }, - "values": { - "description": "The list of the metric values.", - "type": "array", - "items": { - "type": "integer" - } - } - } - }, - "MetricSets": { - "description": "The metrics data represented set.", - "type": "object", - "properties": { - "sets": { - "description": "The list of metric set.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSet" - } - }, - "timeStamps": { - "description": "The list of timestamps for each metric in the metric set.", - "type": "array", - "items": { - "type": "string", - "format": "date-time" - } - } - } - }, - "ModuleConfiguration": { - "description": "The module configuration as required by the Agent service.", - "type": "object", - "properties": { - "agentService": { - "description": "The name of agent service.", - "type": "string" - }, - "moduleName": { - "description": "The name of the module for which the configuration is applicable.", - "type": "string" - }, - "properties": { - "description": "The key value pairs of properties required for configuration.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ModuleConfigurations": { - "description": "The list of module configurations.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ModuleConfiguration" - } - } - } - }, - "ObjectWithSyncError": { - "description": "The objects withg sync errors.", - "type": "object", - "properties": { - "sourceOfAuthority": { - "description": "The source of authority.", - "type": "string" - }, - "displayName": { - "description": "The display name.", - "type": "string" - }, - "objectType": { - "description": "The object type.", - "type": "string" - }, - "attributeName": { - "description": "The attribute name.", - "type": "string" - }, - "attributeValue": { - "description": "The attribute value.", - "type": "string" - }, - "modififedValue": { - "description": "The modified value.", - "type": "string" - }, - "userPrincipalName": { - "description": "The user principal name.", - "type": "string" - }, - "objectGuid": { - "description": "The object guid.", - "type": "string" - }, - "attributeMultiValues": { - "description": "Indicates if the atttibute is multi-valued or not.", - "type": "boolean" - }, - "minLimit": { - "description": "The minimum limit.", - "type": "string" - }, - "maxLimit": { - "description": "The maximum limit.", - "type": "string" - }, - "distinguishedName": { - "description": "The distinguished name.", - "type": "string" - }, - "mail": { - "description": "The email.", - "type": "string" - }, - "timeOccured": { - "description": "The date and time of occurance.", - "type": "string", - "format": "date-time" - }, - "errorType": { - "description": "The error type.", - "type": "string" - }, - "sourceAnchor": { - "description": "The source anchor.", - "type": "string" - } - } - }, - "Operation": { - "description": "The details of the operation.", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation.", - "type": "string" - }, - "display": { - "description": "The display details for the operation.", - "type": "object", - "items": { - "$ref": "#/definitions/Display" - } - } - } - }, - "OperationListResponse": { - "description": "Lists all of the available REST API operations for Azure Active Directory Connect Health.", - "type": "object", - "properties": { - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - }, - "value": { - "description": "List of operations supported by the Microsoft.ADHybridhHealthService resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "totalCount": { - "description": "The total count of opertaions.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token to get next set of operations.", - "type": "string" - } - - } - }, - "Partition": { - "description": "Describes the partition in Synchronization service.", - "type": "object", - "properties": { - "id": { - "description": "The partition Id.", - "type": "string" - }, - "dn": { - "description": "The distinguished name for the partition.", - "type": "string" - }, - "enabled": { - "description": "Indicates if the partition object is selected or not.", - "type": "boolean" - }, - "timeCreated": { - "description": "The date and time when the partition is created.", - "type": "string", - "format": "date-time" - }, - "timeLastModified": { - "description": "The time and date when the partition was last modified.", - "type": "string", - "format": "date-time" - }, - "partitionScope": { - "description": "The scope of the partition.", - "$ref": "#/definitions/PartitionScope" - }, - "name": { - "description": "The name of the partition.", - "type": "string" - }, - "isDomain": { - "description": "Indicates if the partition is a domain or not.", - "type": "boolean" - }, - "type": { - "description": "The partition type.", - "type": "string" - } - } - - }, - "PartitionScope": { - "description": "The connector partition scope.", - "type": "object", - "properties": { - "isDefault": { - "description": "Indicates if the partition scope is default or not.", - "type": "boolean" - }, - "objectClasses": { - "description": "The in-scope object classes.", - "type": "array", - "items": { - "type": "string" - } - }, - "containersIncluded": { - "description": "The list of containers included.", - "type": "array", - "items": { - "type": "string" - } - }, - "containersExcluded": { - "description": "The list of containers excluded.", - "type": "array", - "items": { - "type": "string" - } - } - } - - }, - "PasswordManagementSettings": { - "description": "The password management settings.", - "type": "object", - "properties": { - "enabled": { - "description": "Indicates if the password extension is enabled.", - "type": "boolean" - }, - "extensionFilePath": { - "description": "The file path of the password management extension.", - "type": "string" - }, - "connectTo": { - "description": "Connection point of password management.", - "type": "string" - }, - "connectionTimeout": { - "description": "Connection timeoit for password extension.", - "type": "integer" - }, - "user": { - "description": "User to execute password extension.", - "type": "string" - }, - "supportedPasswordOperations": { - "description": "The supported password operations.", - "type": "string", - "enum": [ - "Undefined", - "Set", - "Change" - ], - "x-ms-enum": { - "name": "PasswordOperationTypes", - "modelAsString": true - } - }, - "maximumRetryCount": { - "description": "The maximum number of retries.", - "type": "integer" - }, - "retryIntervalInSeconds": { - "description": "The time between retries.", - "type": "integer" - }, - "requiresSecureConnection": { - "description": "Indicates if a secure connection is required for password management.", - "type": "boolean" - }, - "unlockAccount": { - "description": "Indicates if accounts should be unloacked when resetting password.", - "type": "boolean" - } - } - }, - "PasswordHashSyncConfiguration": { - "description": "The password has synchronization configuration settings.", - "type": "object", - "properties": { - "enabled": { - "description": "Indicates if the password hash synchronization configuration settings is enabled.", - "type": "boolean" - }, - "target": { - "description": "The target.", - "type": "string" - } - } - }, - "ReplicationDetailsList": { - "description": "The list of replication details.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ReplicationSummary" - } - }, - "totalCount": { - "description": "The total count of replication detail elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - }, - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - } - } - }, - "ReplicationStatus": { - "description": " Replication summary for a domain controller.", - "type": "object", - "properties": { - "forestName": { - "description": "The forest name.", - "type": "string" - }, - "totalDcCount": { - "description": "The total numbe of domain controllers for a given forest.", - "type": "integer" - }, - "errorDcCount": { - "description": "The total number of domain controllers with error in a given forest.", - "type": "integer" - } - } - }, - "ReplicationSummary": { - "description": "The replication summary for a domain controller.", - "type": "object", - "properties": { - "targetServer": { - "description": "The domain controller name.", - "type": "string" - }, - "site": { - "description": "The site name for a given domain controller.", - "type": "string" - }, - "domain": { - "description": "The domain name for a given domain controller.", - "type": "string" - }, - "status": { - "description": "The health status for a domain controller.", - "type": "integer" - }, - "lastAttemptedSync": { - "description": "The last time when a sync was attempted for a given domain controller.", - "type": "string", - "format": "date-time" - }, - "lastSuccessfulSync": { - "description": "The time when the last successful sync happened for a given domain controller.", - "type": "string", - "format": "date-time" - }, - "inboundNeighborCollection": { - "description": "List of individual domain controller neighbor's inbound replication status.", - "type": "array", - "items": { - "$ref": "#/definitions/InboundReplicationNeighbor" - } - } - } - }, - "ReplicationSummaryList": { - "description": "The list of replication summary details.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ReplicationSummary" - } - } - } - }, - "Result": { - "description": "The result for an operation.", - "type": "object", - "properties": { - "value": { - "description": "The value.", - "type": "boolean" - } - } - }, - "RuleErrorInfo": { - "description": "The error details in legacy rule processing.", - "type": "object", - "properties": { - "attributeMapping": { - "description": "The attribute mapping details.", - "$ref": "#/definitions/AttributeMapping" - }, - "connectorId": { - "description": "The connector Id.", - "type": "string" - }, - "connectorName": { - "description": "The connector name.", - "type": "string" - }, - "csObjectId": { - "description": "The object Id.", - "type": "string" - }, - "dn": { - "description": "The distinguished name.", - "type": "string" - } - } - }, - "RunStep": { - "description": "The run step for a run profile.", - "type": "object", - "properties": { - "batchSize": { - "description": "The batch size used by the run step.", - "type": "integer" - }, - "objectProcessLimit": { - "description": "The obect processing limit.", - "type": "integer" - }, - "objectDeleteLimit": { - "description": "The object deletion limit.", - "type": "integer" - }, - "pageSize": { - "description": "The page size of the run step.", - "type": "integer" - }, - "partitionId": { - "description": "The Id of the partition that a current run setp operation is executing.", - "type": "string" - }, - "operationType": { - "description": "The run step operation types.", - "type": "integer" - }, - "timeout": { - "description": "The operation timeout.", - "type": "integer" - } - } - }, - "RunProfile": { - "description": "Describes the run profile.", - "type": "object", - "properties": { - "id": { - "description": "The run profile Id.", - "type": "string" - }, - "name": { - "description": "The run profile name", - "type": "string" - }, - "runSteps": { - "description": "The run steps of the run profile.", - "type": "array", - "items": { - "$ref": "#/definitions/RunStep" - } - } - } - }, - "RunProfiles": { - "description": "The list of run profiles.", - "type": "object", - "properties": { - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/RunProfile" - } - } - } - }, - "ServiceConfiguration": { - "description": "The service configuration", - "type": "object", - "properties": { - "version": { - "description": "The version of the sync service.", - "type": "string" - }, - "serviceType": { - "description": "The service type of the server.", - "type": "integer" - }, - "serviceAccount": { - "description": "The service account.", - "type": "string" - }, - "sqlServer": { - "description": "The SQL server information.", - "type": "string" - }, - "sqlVersion": { - "description": "The SQL version.", - "type": "string" - }, - "sqlEdition": { - "description": "The SQL edition", - "type": "string" - }, - "sqlInstance": { - "description": "The SQL instance details.", - "type": "string" - }, - "sqlDatabaseName": { - "description": "The SQL database.", - "type": "string" - }, - "sqlDatabaseSize": { - "description": "The SQL database size.", - "type": "integer" - } - } - }, - "ServiceProperties": { - "description": "The service properties for a given service.", - "type": "object", - "properties": { - "id": { - "description": "The id of the service.", - "type": "string" - }, - "activeAlerts": { - "description": "The count of alerts that are currently active for the service.", - "type": "integer" - }, - "additionalInformation": { - "description": "The additional information related to the service.", - "type": "string" - }, - "createdDate": { - "description": "The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.", - "type": "string", - "format": "date-time" - }, - "customNotificationEmails": { - "description": "The list of additional emails that are configured to recieve notifications about the service.", - "type": "array", - "items": { - "type": "string" - } - }, - "disabled": { - "description": "Indicates if the service is disabled or not.", - "type": "boolean" - }, - "displayName": { - "description": "The display name of the service.", - "type": "string" - }, - "health": { - "description": "The health of the service.", - "type": "string" - }, - "lastDisabled": { - "description": "The date and time, in UTC, when the service was last disabled.", - "type": "string", - "format": "date-time" - }, - "lastUpdated": { - "description": "The date or time , in UTC, when the service properties were last updated.", - "type": "string", - "format": "date-time" - }, - "monitoringConfigurationsComputed": { - "description": "The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "object", - "items": { - "$ref": "#/definitions/Items" - } - }, - "monitoringConfigurationsCustomized": { - "description": "The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "object", - "items": { - "$ref": "#/definitions/Items" - } - }, - "notificationEmailEnabled": { - "description": "Indicates if email notification is enabled or not.", - "type": "boolean" - }, - "notificationEmailEnabledForGlobalAdmins": { - "description": "Indicates if email notification is enabled for global administrators of the tenant.", - "type": "boolean" - }, - "notificationEmailsEnabledForGlobalAdmins": { - "description": "Indicates if email notification is enabled for global administrators of the tenant.", - "type": "boolean" - }, - "notificationEmails": { - "description": "The list of emails to whom service notifications will be sent.", - "type": "array", - "items": { - "type": "string" - } - }, - "originalDisabledState": { - "description": "Gets the original disable state.", - "type": "boolean" - }, - "resolvedAlerts": { - "description": "The total count of alerts that has been resolved for the service.", - "type": "integer" - }, - "serviceId": { - "description": "The id of the service.", - "type": "string" - }, - "serviceName": { - "description": "The name of the service.", - "type": "string" - }, - "signature": { - "description": "The signature of the service.", - "type": "string" - }, - "simpleProperties": { - "description": "List of service specific configuration properties.", - "type": "object", - "items": { - "$ref": "#/definitions/Items" - } - }, - "tenantId": { - "description": "The id of the tenant to which the service is registered to.", - "type": "string" - }, - "type": { - "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", - "type": "string" - } - } - }, - "Services": { - "description": "The list of services for a given onboarded tenant.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceProperties" - } - }, - "totalCount": { - "description": "The total count of service elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "ServiceMember": { - "description": "The server properties for a given service.", - "type": "object", - "properties": { - "serviceMemberId": { - "description": "The id of the server.", - "type": "string" - }, - "serviceId": { - "description": "The service id to whom this server belongs.", - "type": "string" - }, - "tenantId": { - "description": "The tenant id to whom this server belongs.", - "type": "string" - }, - "activeAlerts": { - "description": "The total number of alerts that are currently active for the server.", - "type": "integer" - }, - "additionalInformation": { - "description": "The additional information, if any, for the server.", - "type": "string" - }, - "createdDate": { - "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", - "type": "string", - "format": "date-time" - }, - "dimensions": { - "description": "The server specific configuration related dimensions.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "disabled": { - "description": "Indicates if the server is disabled or not. ", - "type": "boolean" - }, - "disabledReason": { - "description": "The reason for disabling the server.", - "type": "integer" - }, - "installedQfes": { - "description": "The list of installed QFEs for the server.", - "type": "object", - "items": { - "$ref": "#/definitions/Hotfix" - } - }, - "lastDisabled": { - "description": "The date and time , in UTC, when the server was last disabled.", - "type": "string", - "format": "date-time" - }, - "lastReboot": { - "description": "The date and time, in UTC, when the server was last rebooted.", - "type": "string", - "format": "date-time" - }, - "lastServerReportedMonitoringLevelChange": { - "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", - "type": "string", - "format": "date-time" - }, - "lastUpdated": { - "description": "The date and time, in UTC, when the server proeprties were last updated.", - "type": "string", - "format": "date-time" - }, - "machineId": { - "description": "The id of the machine.", - "type": "string" - }, - "machineName": { - "description": "The name of the server.", - "type": "string" - }, - "monitoringConfigurationsComputed": { - "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "monitoringConfigurationsCustomized": { - "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "osName": { - "description": "The name of the operating system installed in the machine.", - "type": "string" - }, - "osVersion": { - "description": "The version of the operating system installed in the machine.", - "type": "string" - }, - "properties": { - "description": "Server specific properties.", - "type": "object", - "items": { - "$ref": "#/definitions/Item" - } - }, - "recommendedQfes": { - "description": "The list of recommended hotfixes for the server.", - "type": "object", - "items": { - "$ref": "#/definitions/Hotfix" - } - }, - "resolvedAlerts": { - "description": "The total count of alerts that are resolved for this server.", - "type": "integer" - }, - "role": { - "description": "The service role that is being monitored in the server.", - "type": "string" - }, - "serverReportedMonitoringLevel": { - "description": "The monitoring level reported by the server.", - "type": "string", - "enum": [ - "Partial", - "Full", - "Off" - ], - "x-ms-enum": { - "name": "MonitoringLevel", - "modelAsString": false - } - }, - "status": { - "description": "The health status of the server.", - "type": "string" - } - } - }, - "ServiceMembers": { - "description": "The list of servers that are onboarded for a given service.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The value returned by the operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceMember" - } - }, - "totalCount": { - "description": "The total count of service elements.", - "type": "integer" - }, - "continuationToken": { - "description": "The continuation token for paginated calls.", - "type": "string" - } - } - }, - "TabularExportError": { - "description": "The details for export error.", - "type": "object", - "properties": { - "serviceId": { - "description": "The service Id.", - "type": "string", - "format": "uuid" - }, - "serviceMemberId": { - "description": "The server Id.", - "type": "string", - "format": "uuid" - }, - "mergedEntityId": { - "description": "The merged entity Id.", - "type": "string", - "format": "uuid" - }, - "tabularExportErrorData": { - "description": "The export error data.", - "type": "string" - } - } - }, - "Tenant": { - "description": "The details of the onboarded tenant.", - "type": "object", - "properties": { - "tenantId": { - "type": "string", - "description": "The Id of the tenant." - }, - "aadLicense": { - "type": "string", - "description": "The Azure Active Directory license of the tenant." - }, - "aadPremium": { - "type": "boolean", - "description": "Indicate if the tenant has Azure Active Directory Premium license or not." - }, - "agentAutoUpdate": { - "type": "boolean", - "description": "Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features." - }, - "alertSuppressionTimeInMins": { - "type": "integer", - "description": "The time in minutues after which an alert will be autosupressed." - }, - "consentedToMicrosoftDevOps": { - "type": "boolean", - "description": "Indicates if the tenant data can be seen by Microsoft through Azure portal." - }, - "countryLetterCode": { - "type": "string", - "description": "The country letter code of the tenant." - }, - "createdDate": { - "type": "string", - "format": "date-time", - "description": "The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health." - }, - "devOpsTtl": { - "type": "string", - "format": "date-time", - "description": "The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal." - }, - "disabled": { - "type": "boolean", - "description": "Indicates if the tenant is disabled in Azure Active Directory Connect Health." - }, - "disabledReason": { - "type": "integer", - "description": "The reason due to which the tenant was disabled in Azure Active Directory Connect Health." - }, - "globalAdminsEmail": { - "type": "object", - "items": { - "type": "string" - }, - "description": "The list of golbal administrators for the tenant." - }, - "initialDomain": { - "type": "string", - "description": "The initial domain of the tenant." - }, - "lastDisabled": { - "type": "string", - "format": "date-time", - "description": "The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health." - }, - "lastVerified": { - "type": "string", - "format": "date-time", - "description": "The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified." - }, - "onboardingAllowed": { - "type": "boolean", - "description": "Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health." - }, - "onboarded": { - "type": "boolean", - "description": "Indicates if the tenant is already onboarded to Azure Active Directory Connect Health." - }, - "pksCertificate": { - "type": "object", - "description": "The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health." - }, - "privatePreviewTenant": { - "type": "boolean", - "description": "Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features." - }, - "tenantInQuarantine": { - "type": "boolean", - "description": "Indicates if data collection for this tenant is disabled or not." - }, - "tenantName": { - "type": "string", - "description": "The name of the tenant." - } - } - }, - "TenantOnboardingDetails": { - "description": "The tenant onboarding details.", - "type": "object", - "properties": { - "tenantOnboarded": { - "description": "Indicates if the tenant is onboarded to Azure Active Directory Connect Health or not.", - "type": "boolean" - }, - "onboardingDisplayUrl": { - "description": "The display url, to help tenant navigate or onboard to Azure Active Directory Connect Health blade, based on tenant onboarding status.", - "type": "string" - } - } - }, - "UserPreference": { - "description": " The user preference for a given feature.", - "type": "object", - "properties": { - "metricNames": { - "description": "The name of the metric.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ValueDelta": { - "description": "The value of the delta.", - "type": "object", - "properties": { - "operationType": { - "description": "The operation type.", - "type": "string", - "enum": [ - "Undefined", - "Add", - "Update", - "Delete" - ], - "x-ms-enum": { - "name": "ValueDeltaOperationType", - "modelAsString": true - } - }, - "value": { - "description": "The value of the delta.", - "type": "string" - } - } - } - }, - "parameters": { - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The version of the API to be used with the client request.", - "required": true, - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow.", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ "user_impersonation" ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2014-01-01", + "title": "ADHybridHealthService", + "description": "REST APIs for Azure Active Drectory Connect Health" + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.ADHybridHealthService/addsservices": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.", + "operationId": "addsServices_list", + "x-ms-examples": { + "addsServices_list": { + "$ref": "./examples/Services.json" + } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " The list of Active Directory Domain Controller services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", + "operationId": "addsServices_add", + "x-ms-examples": { + "addsServices_add": { + "$ref": "./examples/AddService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + ], + "responses": { + "200": { + "description": "Adds the Active Directory Domain Controller Services.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_get": { + "$ref": "./examples/Service.json" + } + }, + "operationId": "addsServices_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Active Directory Domain Controller service as specified by the serviceName property. ", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + }, + "delete": { + "tags": [ "Services" ], + "description": "Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_delete": { + "$ref": "./examples/DeleteService.json" + } + }, + "operationId": "addsServices_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the service." + } + } + }, + "patch": { + "tags": [ "Services" ], + "description": "Updates an Active Directory Domain Service properties of an onboarded service.", + "x-ms-examples": { + "addsServices_update": { + "$ref": "./examples/UpdateService.json" + } + }, + "operationId": "addsServices_update", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Sucessfully updated service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the alerts for a given Active Directory Domain Service.", + "x-ms-examples": { + "alerts_listAddsAlerts": { + "$ref": "./examples/Alerts.json" + } + }, + "operationId": "alerts_listAddsAlerts", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts for the given service.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service configurations.", + "x-ms-examples": { + "configuration_listAddsConfigurations": { + "$ref": "./examples/AddsConfiguration.json" + } + }, + "operationId": "configuration_listAddsConfigurations", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "grouping", + "in": "query", + "description": "The grouping for configurations.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The Active Directory Domain Controller service configuration. ", + "schema": { + "$ref": "#/definitions/AddsConfiguration" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/dimensions/{dimension}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the dimensions for a given dimension type in a server.", + "x-ms-examples": { + "dimensions_listAddsDimensions": { + "$ref": "./examples/Dimensions.json" + } + }, + "operationId": "dimensions_listAddsDimensions", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "dimension", + "in": "path", + "description": "The dimension type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of dimensions for a server. ", + "schema": { + "$ref": "#/definitions/Dimensions" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServiceMembers_list": { + "$ref": "./examples/AddsServiceMembers.json" + } + }, + "operationId": "addsServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Active Directory Domain Servers. ", + "schema": { + "$ref": "#/definitions/AddsServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addomainservicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "adDomainServiceMembers_list": { + "$ref": "./examples/AddomainServiceMembers.json" + } + }, + "operationId": "adDomainServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "isGroupbySite", + "in": "query", + "description": "Indicates if the result should be grouped by site or not.", + "required": true, + "type": "boolean" + }, + { + "name": "query", + "in": "query", + "description": "The custom query.", + "required": false, + "type": "string" + }, + { + "name": "nextPartitionKey", + "in": "query", + "description": "The next partition key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextPartitionKey", + "modelAsString": true + } + }, + { + "name": "nextRowKey", + "in": "query", + "description": "The next row key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextRowKey", + "modelAsString": true + } + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of Active Directory Domain Servers.", + "schema": { + "$ref": "#/definitions/AddsServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/features/{featureName}/userpreference": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_get": { + "$ref": "./examples/UserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The user preference settings. ", + "schema": { + "$ref": "#/definitions/UserPreference" + } + } + } + }, + "delete": { + "tags": [ "Adds" ], + "description": "Deletes the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_delete": { + "$ref": "./examples/DeleteUserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user preference settings. " + } + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Adds the user preferences for a given feature.", + "x-ms-examples": { + "addsServicesUserPreference_add": { + "$ref": "./examples/AddUserPreference.json" + } + }, + "operationId": "addsServicesUserPreference_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "name": "setting", + "in": "body", + "description": "The user preference setting.", + "required": true, + "schema": { + "$ref": "#/definitions/UserPreference" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " Successfully added the user preference settings. " + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/forestsummary": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_getForestSummary": { + "$ref": "./examples/ForestSummary.json" + } + }, + "operationId": "addsServices_getForestSummary", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of forest summary for the service. ", + "schema": { + "$ref": "#/definitions/ForestSummary" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "addsService_getMetrics": { + "$ref": "./examples/Service_MetricSets.json" + } + }, + "operationId": "addsService_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for the service. ", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the average of the metric values for a given metric and group combination.", + "x-ms-examples": { + "addsServices_listMetricsAverage": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "addsServices_listMetricsAverage", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metrics. ", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the sum of the metric values for a given metric and group combination.", + "x-ms-examples": { + "addsServices_listMetricsSum": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "addsServices_listMetricsSum", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of aum of the metric values for a given service. ", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "addsServices_listMetricMetadata": { + "$ref": "./examples/MetricMetadataList.json" + } + }, + "operationId": "addsServices_listMetricMetadata", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The metric metadata property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "perfCounter", + "in": "query", + "description": "Indicates if only performance counter metrics are requested.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric metadata for a service. ", + "schema": { + "$ref": "#/definitions/MetricMetadataList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metric information.", + "x-ms-examples": { + "addsServices_getMetricMetadata": { + "$ref": "./examples/MetricMetadata.json" + } + }, + "operationId": "addsServices_getMetricMetadata", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": " The metric metadata for the service.", + "schema": { + "$ref": "#/definitions/MetricMetadata" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the service related metrics for a given metric and group combination.", + "x-ms-examples": { + "addsServices_getMetricMetadataForGroup": { + "$ref": "./examples/MetricSets.json" + } + }, + "operationId": "addsServices_getMetricMetadataForGroup", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service and group. ", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationdetails": { + "get": { + "tags": [ "Adds" ], + "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listReplicationDetails": { + "$ref": "./examples/ReplicationDetails.json" + } + }, + "operationId": "addsServices_listReplicationDetails", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "withDetails", + "in": "query", + "description": "Indicates if InboundReplicationNeighbor details are required or not.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of replication details for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationDetailsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationstatus": { + "get": { + "tags": [ "Adds" ], + "description": "Gets Replication status for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServicesReplicationStatus_get": { + "$ref": "./examples/ReplicationStatus.json" + } + }, + "operationId": "addsServicesReplicationStatus_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The replication status for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationStatus" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/replicationsummary": { + "get": { + "tags": [ "Adds" ], + "description": "Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listReplicationSummary": { + "$ref": "./examples/ReplicationSummary.json" + } + }, + "operationId": "addsServices_listReplicationSummary", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "isGroupbySite", + "in": "query", + "description": "Indicates if the result should be grouped by site or not.", + "required": true, + "type": "boolean" + }, + { + "name": "query", + "in": "query", + "description": "The custom query.", + "required": true, + "type": "string" + }, + { + "name": "nextPartitionKey", + "in": "query", + "description": "The next partition key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextPartitionKey", + "modelAsString": true + } + }, + { + "name": "nextRowKey", + "in": "query", + "description": "The next row key to query for.", + "required": true, + "type": "string", + "enum": [ " " ], + "x-ms-enum": { + "name": "nextRowKey", + "modelAsString": true + } + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of replication summary for a service. ", + "schema": { + "$ref": "#/definitions/ReplicationSummaryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServicesServiceMembers_list": { + "$ref": "./examples/ServiceMembers.json" + } + }, + "operationId": "addsServicesServiceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "dimensionType", + "in": "query", + "description": "The server specific dimension.", + "required": false, + "type": "string" + }, + { + "name": "dimensionSignature", + "in": "query", + "description": "The value of the dimension.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service members for a given service.", + "schema": { + "$ref": "#/definitions/ServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Adds" ], + "description": "Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServicesServiceMembers_add": { + "$ref": "./examples/AddServiceMembers.json" + } + }, + "operationId": "addsServicesServiceMembers_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service under which the server is to be onboarded.", + "required": true, + "type": "string" + }, + { + "name": "serviceMember", + "in": "body", + "description": "The server object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceMember" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_get": { + "$ref": "./examples/ServiceMember.json" + } + }, + "operationId": "addsServiceMembers_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service member details for a given service. ", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + }, + "delete": { + "tags": [ "Adds" ], + "description": "Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_delete": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "addsServiceMembers_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/alerts": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the details of an alert for a given Active Directory Domain Controller service and server combination.", + "x-ms-examples": { + "addsServices_listServerAlerts": { + "$ref": "./examples/Server_Alerts.json" + } + }, + "operationId": "addsServices_listServerAlerts", + "parameters": [ + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id for which the alert details needs to be queried.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of server alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials": { + "get": { + "tags": [ "Adds" ], + "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "addsServiceMembers_listCredentials": { + "$ref": "./examples/Credentials.json" + } + }, + "operationId": "addsServiceMembers_listCredentials", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of server credentials.", + "schema": { + "$ref": "#/definitions/Credentials" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "addsServices_listPremiumServices": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "addsServices_listPremiumServices", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of premium services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/operations": { + "get": { + "tags": [ + "operations" + ], + "x-ms-examples": { + "operations_list": { + "$ref": "./examples/OperationList.json" + } + }, + "operationId": "operations_list", + "description": "Lists the available Azure Data Factory API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/configuration": { + "post": { + "tags": [ "Configuration" ], + "description": "Onboards a tenant in Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_add": { + "$ref": "./examples/Tenant.json" + } + }, + "operationId": "configuration_add", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the tenant.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + }, + "get": { + "tags": [ "Configuration" ], + "description": "Gets the details of a tenant onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_get": { + "$ref": "./examples/Tenant.json" + } + }, + "operationId": "configuration_get", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The tenant details.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + }, + "patch": { + "tags": [ "Configuration" ], + "description": "Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "configuration_update": { + "$ref": "./examples/PatchTenant.json" + } + }, + "operationId": "configuration_update", + "parameters": [ + { + "name": "tenant", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tenant" + }, + "description": "The tenant object with the properties set to the updated value." + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the tenant.", + "schema": { + "$ref": "#/definitions/Tenant" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/reports/DevOps/IsDevOps": { + "get": { + "tags": [ "DevOps" ], + "description": "Checks if the user is enabled for Dev Ops access.", + "x-ms-examples": { + "reports_getDevOps": { + "$ref": "./examples/DevOps.json" + } + }, + "operationId": "reports_getDevOps", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if the user is Dev Ops or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_list": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "services_list", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "Services" ], + "description": "Onboards a service for a given tenant in Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_add": { + "$ref": "./examples/AddService.json" + } + }, + "operationId": "services_add", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + ], + "responses": { + "200": { + "description": "Successfully added the service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/premiumCheck": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_listPremium": { + "$ref": "./examples/Services.json" + } + }, + "operationId": "services_listPremium", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The service property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceType", + "in": "query", + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "required": false, + "type": "string" + }, + { + "name": "skipCount", + "in": "query", + "description": "The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements.", + "required": false, + "type": "integer" + }, + { + "name": "takeCount", + "in": "query", + "description": "The take count , which specifies the number of elements that can be returned from a sequence.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of premium services.", + "schema": { + "$ref": "#/definitions/Services" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}": { + "get": { + "tags": [ "Services" ], + "description": "Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_get": { + "$ref": "./examples/Service.json" + } + }, + "operationId": "services_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of services.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + }, + "delete": { + "tags": [ "Services" ], + "description": "Deletes a service which is onboarded to Azure Active Directory Connect Health.", + "x-ms-examples": { + "services_delete": { + "$ref": "./examples/DeleteService.json" + } + }, + "operationId": "services_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the service." + } + } + }, + "patch": { + "tags": [ "Services" ], + "description": "Updates the service properties of an onboarded service.", + "x-ms-examples": { + "services_update": { + "$ref": "./examples/UpdateService.json" + } + }, + "operationId": "services_update", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service which needs to be deleted.", + "required": true, + "type": "string" + }, + { + "name": "service", + "in": "body", + "description": "The service object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the service.", + "schema": { + "$ref": "#/definitions/ServiceProperties" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Gets the alerts for a given service.", + "x-ms-examples": { + "services_listAlerts": { + "$ref": "./examples/Alerts.json" + } + }, + "operationId": "services_listAlerts", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}": { + "get": { + "tags": [ "Services" ], + "description": "Checks if the service has all the pre-requisites met to use a feature.", + "x-ms-examples": { + "services_getFeatureAvailibility": { + "$ref": "./examples/CheckFeatureAvailibility.json" + } + }, + "operationId": "services_getFeatureAvailibility", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if the feature is available or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts": { + "get": { + "tags": [ "Services" ], + "description": "Gets the count of latest AAD export errors.", + "x-ms-examples": { + "services_listExportErrors": { + "$ref": "./examples/ErrorCounts.json" + } + }, + "operationId": "services_listExportErrors", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export errors.", + "schema": { + "$ref": "#/definitions/ErrorCounts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2": { + "get": { + "tags": [ "Services" ], + "description": " Gets the categorized export errors.", + "x-ms-examples": { + "services_listExportErrorsV2": { + "$ref": "./examples/MergedExportErrors.json" + } + }, + "operationId": "services_listExportErrorsV2", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "errorBucket", + "in": "query", + "description": "The error category to query for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of merged export errors.", + "schema": { + "$ref": "#/definitions/MergedExportErrors" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus": { + "get": { + "tags": [ "Services" ], + "description": "Gets the export status.", + "x-ms-examples": { + "services_listExportStatus": { + "$ref": "./examples/ExportStatus.json" + } + }, + "operationId": "services_listExportStatus", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export statuses.", + "schema": { + "$ref": "#/definitions/ExportStatuses" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/feedback": { + "post": { + "tags": [ "Feedback" ], + "description": "Adds an alert feedback submitted by customer.", + "x-ms-examples": { + "services_addAlertFeedback": { + "$ref": "./examples/AddAlertFeedback.json" + } + }, + "operationId": "services_addAlertFeedback", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "alertFeedback", + "in": "body", + "description": "The alert feedback.", + "required": true, + "schema": { + "$ref": "#/definitions/AlertFeedback" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added alert feedback.", + "schema": { + "$ref": "#/definitions/AlertFeedback" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/feedbacktype/alerts/{shortName}/alertfeedback": { + "get": { + "tags": [ "Feedback" ], + "description": "Gets a list of all alert feedback for a given tenant and alert type.", + "x-ms-examples": { + "services_listAlertFeedback": { + "$ref": "./examples/GetAlertFeedback.json" + } + }, + "operationId": "services_listAlertFeedback", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "shortName", + "in": "path", + "description": "The name of the alert.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alert feedback.", + "schema": { + "$ref": "#/definitions/AlertFeedbacks" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "service_getMetrics": { + "$ref": "./examples/Service_MetricSets.json" + } + }, + "operationId": "service_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/average": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the average of the metric values for a given metric and group combination.", + "x-ms-examples": { + "services_listMetricsAverage": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "services_listMetricsAverage", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of average metrics for a given service.", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metrics/{metricName}/groups/{groupName}/sum": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the sum of the metric values for a given metric and group combination.", + "x-ms-examples": { + "services_listMetricsSum": { + "$ref": "./examples/Metrics.json" + } + }, + "operationId": "services_listMetricsSum", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metrics for a given service.", + "schema": { + "$ref": "#/definitions/Metrics" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "services_listMetricMetadata": { + "$ref": "./examples/MetricMetadataList.json" + } + }, + "operationId": "services_listMetricMetadata", + "parameters": [ + { + "name": "$filter", + "in": "query", + "description": "The metric metadata property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "perfCounter", + "in": "query", + "description": "Indicates if only performance counter metrics are requested.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric metadata for a given service.", + "schema": { + "$ref": "#/definitions/MetricMetadataList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics information.", + "x-ms-examples": { + "services_getMetricMetadata": { + "$ref": "./examples/MetricMetadata.json" + } + }, + "operationId": "services_getMetricMetadata", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric metadata for a given metric.", + "schema": { + "$ref": "#/definitions/MetricMetadata" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/metricmetadata/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the service related metrics for a given metric and group combination.", + "x-ms-examples": { + "services_getMetricMetadataForGroup": { + "$ref": "./examples/MetricSets.json" + } + }, + "operationId": "services_getMetricMetadataForGroup", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric sets for a given service and group.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration": { + "patch": { + "tags": [ "Services" ], + "description": "Updates the service level monitoring configuration.", + "x-ms-examples": { + "services_updateMonitoringConfiguration": { + "$ref": "./examples/PatchMonitoringConfiguration.json" + } + }, + "operationId": "services_updateMonitoringConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "configurationSetting", + "in": "body", + "description": "The monitoring configuration to update", + "required": true, + "schema": { + "$ref": "#/definitions/Item" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the monitoring configuration." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations": { + "get": { + "tags": [ "Services" ], + "description": "Gets the service level monitoring configurations.", + "x-ms-examples": { + "services_listMonitoringConfigurations": { + "$ref": "./examples/MonitoringConfigurations.json" + } + }, + "operationId": "services_listMonitoringConfigurations", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of monitoring configurations.", + "schema": { + "$ref": "#/definitions/Items" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/reports/badpassword/details/user": { + "get": { + "tags": [ "Reports" ], + "description": "Gets the bad password login attempt report for an user", + "x-ms-examples": { + "services_listUserBadPasswordReport": { + "$ref": "./examples/BadPasswordDetails.json" + } + }, + "operationId": "services_listUserBadPasswordReport", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "dataSource", + "in": "query", + "description": "The source of data, if its test data or customer data.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of bad password login attempts.", + "schema": { + "$ref": "#/definitions/ErrorReportUsersEntries" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the details of the servers, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_list": { + "$ref": "./examples/ServiceMembers.json" + } + }, + "operationId": "serviceMembers_list", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The server property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "dimensionType", + "in": "query", + "description": "The server specific dimension.", + "required": false, + "type": "string" + }, + { + "name": "dimensionSignature", + "in": "query", + "description": "The value of the dimension.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service members.", + "schema": { + "$ref": "#/definitions/ServiceMembers" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ "ServiceMembers" ], + "description": "Onboards a server, for a given service, to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_add": { + "$ref": "./examples/AddServiceMembers.json" + } + }, + "operationId": "serviceMembers_add", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service under which the server is to be onboarded.", + "required": true, + "type": "string" + }, + { + "name": "serviceMember", + "in": "body", + "description": "The server object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceMember" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the details of a server, for a given service, that are onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_get": { + "$ref": "./examples/ServiceMember.json" + } + }, + "operationId": "serviceMembers_get", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The specific service member.", + "schema": { + "$ref": "#/definitions/ServiceMember" + } + } + } + }, + "delete": { + "tags": [ "ServiceMembers" ], + "description": "Deletes a server that has been onboarded to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_delete": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "serviceMembers_delete", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "confirm", + "in": "query", + "description": "Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Gets the details of an alert for a given service and server combination.", + "x-ms-examples": { + "serviceMembers_listAlerts": { + "$ref": "./examples/Server_Alerts.json" + } + }, + "operationId": "serviceMembers_listAlerts", + "parameters": [ + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id for which the laert details needs to be queried.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The alert property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "state", + "in": "query", + "description": "The alert state to query for.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "The start date to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "The end date till when to query for.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of alerts.", + "schema": { + "$ref": "#/definitions/Alerts" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/service/{serviceName}/servicemembers/{serviceMemberId}/connectors": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the connector details for a service.", + "x-ms-examples": { + "serviceMembers_listConnectors": { + "$ref": "./examples/Connectors.json" + } + }, + "operationId": "serviceMembers_listConnectors", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of connector details.", + "schema": { + "$ref": "#/definitions/Connectors" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/credentials": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_listCredentials": { + "$ref": "./examples/Credentials.json" + } + }, + "operationId": "serviceMembers_listCredentials", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of service member credentials.", + "schema": { + "$ref": "#/definitions/Credentials" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/data": { + "delete": { + "tags": [ "ServiceMembers" ], + "description": "Deletes the data uploaded by the server to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_deleteData": { + "$ref": "./examples/DeleteServer.json" + } + }, + "operationId": "serviceMembers_deleteData", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the service member." + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/datafreshness": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the last time when the server uploaded data to Azure Active Directory Connect Health Service.", + "x-ms-examples": { + "serviceMembers_listDataFreshness": { + "$ref": "./examples/Datafreshness.json" + } + }, + "operationId": "serviceMembers_listDataFreshness", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of datafreshness details for a server.", + "schema": { + "$ref": "#/definitions/DataFreshnessDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/exportstatus": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the export status.", + "x-ms-examples": { + "serviceMembers_listExportStatus": { + "$ref": "./examples/Server_ExportStatus.json" + } + }, + "operationId": "serviceMembers_listExportStatus", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of export statuses.", + "schema": { + "$ref": "#/definitions/ExportStatuses" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/globalconfiguration": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the global configuration.", + "x-ms-examples": { + "serviceMembers_listGlobalConfiguration": { + "$ref": "./examples/GlobalConfiguration.json" + } + }, + "operationId": "serviceMembers_listGlobalConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of global configurations.", + "schema": { + "$ref": "#/definitions/GlobalConfigurations" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/metrics/{metricName}/groups/{groupName}": { + "get": { + "tags": [ "Metrics" ], + "description": "Gets the server related metrics for a given metric and group combination.", + "x-ms-examples": { + "serviceMembers_getMetrics": { + "$ref": "./examples/Server_MetricSets.json" + } + }, + "operationId": "serviceMembers_getMetrics", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "metricName", + "in": "path", + "description": "The metric name", + "required": true, + "type": "string" + }, + { + "name": "groupName", + "in": "path", + "description": "The group name", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "groupKey", + "in": "query", + "description": "The group key", + "required": false, + "type": "string" + }, + { + "name": "fromDate", + "in": "query", + "description": "The start date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "toDate", + "in": "query", + "description": "The end date.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of metric sets for a given metric.", + "schema": { + "$ref": "#/definitions/MetricSets" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/servicemembers/{serviceMemberId}/serviceconfiguration": { + "get": { + "tags": [ "ServiceMembers" ], + "description": "Gets the service configuration.", + "x-ms-examples": { + "serviceMembers_getServiceConfiguration": { + "$ref": "./examples/ServiceConfiguration.json" + } + }, + "operationId": "serviceMembers_getServiceConfiguration", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "serviceMemberId", + "in": "path", + "description": "The server Id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service configuration.", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + } + } + }, + "/providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}": { + "get": { + "tags": [ "Services" ], + "description": "Checks if the tenant, to which a service is registered, is whitelisted to use a feature.", + "x-ms-examples": { + "services_getTenantWhitelisting": { + "$ref": "./examples/TenantWhitelisting.json" + } + }, + "operationId": "services_getTenantWhitelisting", + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service.", + "required": true, + "type": "string" + }, + { + "name": "featureName", + "in": "path", + "description": "The name of the feature.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Indicates if a tenant is whitelisted for a feature or not.", + "schema": { + "$ref": "#/definitions/Result" + } + } + } + } + } + }, + "definitions": { + "AddsConfiguration": { + "description": "The list of key value properties.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "totalCount": { + "description": "The total count of configuration.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "AdditionalInformation": { + "description": "The addtional information for a property.", + "type": "object", + "properties": { + "titleName": { + "description": "The title name for the property.", + "type": "string" + }, + "titleValue": { + "description": "The title value for the property.", + "type": "string" + }, + "properties": { + "description": "The list of properties which are included in the aditional information.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "hasProperties": { + "description": "Indicates if properties are present or not.", + "type": "boolean" + } + } + }, + "AddsServiceMember": { + "description": "The server details for ADDS service.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "siteName": { + "description": "The site name.", + "type": "string" + }, + "addsRoles": { + "description": "The list of ADDS roles.", + "type": "array", + "items": { + "type": "string" + } + }, + "gcReachable": { + "description": "Indicates if the global catalog for this domain is reachable or not.", + "type": "boolean" + }, + "isAdvertising": { + "description": "Indicates if the Dc is advertising or not.", + "type": "boolean" + }, + "pdcReachable": { + "description": "Indicates if the primary domain controller is reachable or not.", + "type": "boolean" + }, + "sysvolState": { + "description": "Indicates if the SYSVOL state is healthy or not.", + "type": "boolean" + }, + "dcTypes": { + "description": "The list of domain controller types.", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceMemberId": { + "description": "The id of the server.", + "type": "string" + }, + "serviceId": { + "description": "The service id to whom this server belongs.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id to whom this server belongs.", + "type": "string" + }, + "activeAlerts": { + "description": "The total number of alerts that are currently active for the server.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information, if any, for the server.", + "type": "string" + }, + "createdDate": { + "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "dimensions": { + "description": "The server specific configuration related dimensions.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "disabled": { + "description": "Indicates if the server is disabled or not. ", + "type": "boolean" + }, + "disabledReason": { + "description": "The reason for disabling the server.", + "type": "integer" + }, + "installedQfes": { + "description": "The list of installed QFEs for the server.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "lastDisabled": { + "description": "The date and time , in UTC, when the server was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastReboot": { + "description": "The date and time, in UTC, when the server was last rebooted.", + "type": "string", + "format": "date-time" + }, + "lastServerReportedMonitoringLevelChange": { + "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the server proeprties were last updated.", + "type": "string", + "format": "date-time" + }, + "machineId": { + "description": "The id of the machine.", + "type": "string" + }, + "machineName": { + "description": "The name of the server.", + "type": "string" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "osName": { + "description": "The name of the operating system installed in the machine.", + "type": "string" + }, + "osVersion": { + "description": "The version of the operating system installed in the machine.", + "type": "string" + }, + "properties": { + "description": "Server specific properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "recommendedQfes": { + "description": "The list of recommended hotfixes for the server.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "resolvedAlerts": { + "description": "The total count of alerts that are resolved for this server.", + "type": "integer" + }, + "role": { + "description": "The service role that is being monitored in the server.", + "type": "string" + }, + "serverReportedMonitoringLevel": { + "description": "The monitoring level reported by the server.", + "type": "string", + "enum": [ + "Partial", + "Full", + "Off" + ], + "x-ms-enum": { + "name": "MonitoringLevel", + "modelAsString": false + } + }, + "status": { + "description": "The health status of the server.", + "type": "string" + } + } + }, + "AddsServiceMembers": { + "description": "The list of ADDS service members.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/AddsServiceMember" + } + }, + "totalCount": { + "description": "The total count of service members.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "Agent": { + "description": "The agent details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id.", + "type": "string" + }, + "machineId": { + "description": "The machine Id.", + "type": "string" + }, + "credential": { + "description": "The agent credential details.", + "type": "object", + "items": { + "$ref": "#/definitions/Credential" + } + }, + "machineName": { + "description": "The machine name.", + "type": "string" + }, + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "createdDate": { + "description": "The date and time, in UTC, when the agent was created.", + "type": "string", + "format": "date-time" + }, + "key": { + "description": " The connector hash key.", + "type": "string" + } + } + }, + "Alert": { + "description": " The alert details indicating an issue with service or server.", + "type": "object", + "properties": { + "alertId": { + "description": "The alert Id.", + "type": "string", + "format": "uuid" + }, + "level": { + "description": "The alert level which indicates the severity of the alert.", + "type": "string", + "enum": [ + "Warning", + "Error", + "PreWarning" + ], + "x-ms-enum": { + "name": "Level", + "modelAsString": true + } + }, + "state": { + "description": "The alert state which can be either active or resolved with multile resolution types.", + "type": "string", + "enum": [ + "Active", + "ResolvedByPositiveResult", + "ResolvedManually", + "ResolvedByTimer", + "ResolvedByStateChange" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "shortName": { + "description": "The alert short name.", + "type": "string" + }, + "displayName": { + "description": "The display name for the alert.", + "type": "string" + }, + "description": { + "description": "The alert description.", + "type": "string" + }, + "remediation": { + "description": "The alert remediation.", + "type": "string" + }, + "relatedLinks": { + "description": "The help links to get more information related to the alert.", + "type": "array", + "items": { + "$ref": "#/definitions/HelpLink" + } + }, + "scope": { + "description": "The scope of the alert. Indicates if it is a service or a server related alert.", + "type": "string" + }, + "additionalInformation": { + "description": "Additional information related to the alert.", + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalInformation" + } + }, + "createdDate": { + "description": "The date and time,in UTC,when the alert was created.", + "type": "string", + "format": "date-time" + }, + "resolvedDate": { + "description": "The date and time, in UTC, when the alert was resolved.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the alert was last updated.", + "type": "string", + "format": "date-time" + }, + "monitorRoleType": { + "description": "The monitoring role type for which the alert was raised.", + "type": "string" + }, + "activeAlertProperties": { + "description": "The active alert properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "resolvedAlertProperties": { + "description": "The resolved alert properties.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "tenantId": { + "description": "The tenant Id.", + "type": "string", + "format": "uuid" + }, + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + } + } + }, + "AlertFeedback": { + "description": "The alert feedback details.", + "type": "object", + "properties": { + "level": { + "description": "The alert level which indicates the severity of the alert.", + "type": "string" + }, + "state": { + "description": "The alert state which can be either active or resolved with multile resolution types.", + "type": "string" + }, + "shortName": { + "description": "The alert short name.", + "type": "string" + }, + "feedback": { + "description": "The feedback for the alert which indicates if the customer likes or dislikes the alert.", + "type": "string" + }, + "comment": { + "description": "Additional comments related to the alert.", + "type": "string" + }, + "consentedToShare": { + "description": "Indicates if the alert feedback can be shared from product team.", + "type": "boolean" + }, + "serviceMemberId": { + "description": "The server Id of the alert.", + "type": "string" + }, + "createdDate": { + "description": "The date and time,in UTC,when the alert was created.", + "type": "string", + "format": "date-time" + } + } + }, + "AlertFeedbacks": { + "description": "The list of alert feedback.", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The value returned by the operation.", + "items": { + "$ref": "#/definitions/AlertFeedback" + } + } + } + }, + "Alerts": { + "description": "The list of alerts for a service.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "totalCount": { + "description": "The total count of alert elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "AssociatedObject": { + "description": "Object that hold sync object details.", + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the object.", + "type": "string" + }, + "distinguishedName": { + "description": "The distinguished name of the object.", + "type": "string" + }, + "lastDirSyncTime": { + "description": "The last dirSync time.", + "type": "string", + "format": "date-time" + }, + "mail": { + "description": "The email of the object.", + "type": "string" + }, + "objectGuid": { + "description": "The object guid.", + "type": "string" + }, + "objectType": { + "description": "The object type.", + "type": "string" + }, + "onpremisesUserPrincipalName": { + "description": "The On-premises UPN.", + "type": "string" + }, + "proxyAddresses": { + "description": "The proxy addresses.", + "type": "string" + }, + "sourceAnchor": { + "description": "The source anchor.", + "type": "string" + }, + "sourceOfAuthority": { + "description": "The source of authority.", + "type": "string" + }, + "timeOccurred": { + "description": " The time of the error.", + "type": "string", + "format": "date-time" + }, + "userPrincipalName": { + "description": " The UPN.", + "type": "string" + } + } + }, + "AttributeDelta": { + "description": "The delta attributes.", + "type": "object", + "properties": { + "values": { + "description": "The delta values.", + "type": "array", + "items": { + "$ref": "#/definitions/ValueDelta" + } + }, + "name": { + "description": "The name of the attribute delta.", + "type": "string" + }, + "operationType": { + "description": "The attribute delta operation type.", + "type": "string", + "enum": [ + "Undefined", + "Add", + "Replace", + "Update", + "Delete" + ], + "x-ms-enum": { + "name": "AttributeDeltaOperationType", + "modelAsString": true + } + }, + "valueType": { + "description": "The value type.", + "type": "string", + "enum": [ + "Undefined", + "Dn", + "Binary", + "String", + "Integer", + "Boolean" + ], + "x-ms-enum": { + "name": "ValueType", + "modelAsString": true + } + }, + "multiValued": { + "description": "Indicates if the attribute delta is multivalued or not.", + "type": "boolean" + } + } + }, + "AttributeMapping": { + "description": "The attribute mapping details.", + "type": "object", + "properties": { + "mappingSource": { + "description": "The mapping source.", + "$ref": "#/definitions/AttributeMppingSource" + }, + "type": { + "description": "The attribute mapping type.", + "type": "string", + "enum": [ + "Constant", + "Direct", + "DnPart", + "Script" + ], + "x-ms-enum": { + "name": "AttributeMappingType", + "modelAsString": true + } + }, + "destinationAttribute": { + "description": "The destination attribute.", + "type": "string" + }, + "contextId": { + "description": "The context Id.", + "type": "string" + } + } + }, + "AttributeMppingSource": { + "description": "The attribute mapping source.", + "type": "object", + "properties": { + "sourceAttribute": { + "description": "The source attribute.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnPart": { + "description": "The value for dn part.", + "type": "integer" + }, + "scriptContext": { + "description": "The script context.", + "type": "string" + }, + "constantValue": { + "description": "The constant value.", + "type": "string" + } + } + }, + "ChangeNotReimported": { + "description": "The changes which are not re-imported.", + "type": "object", + "properties": { + "delta": { + "description": "The delta changes that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimportedDelta" + }, + "entry": { + "description": "The object entry in a change that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimportedEntry" + } + } + }, + "ChangeNotReimportedDelta": { + "description": "The delta in a change that is not re-imported.", + "type": "object", + "properties": { + "anchor": { + "description": "The anchor.", + "type": "string" + }, + "dnAttributes": { + "description": "The delta attributes for distinguished names.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "attributes": { + "description": "The attributes.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "operationType": { + "description": "The operation type.", + "type": "string", + "enum": [ + "Undefined", + "None", + "Add", + "Replace", + "Update", + "Delete", + "Obsolete", + "DeletAdd" + ], + "x-ms-enum": { + "name": "DeltaOperationType", + "modelAsString": true + } + } + } + }, + "ChangeNotReimportedEntry": { + "description": "The object entry in a change that is not re-imported.", + "type": "object", + "properties": { + "anchor": { + "description": "The anchor.", + "type": "string" + }, + "parentAnchor": { + "description": "The parent anchor.", + "type": "string" + }, + "primaryObjectClass": { + "description": "The primary object class.", + "type": "string" + }, + "objectClasses": { + "description": "The olist of object classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnAttributes": { + "description": "The delta attributes for distinguished names.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "attributes": { + "description": "The attributes.", + "type": "array", + "items": { + "$ref": "#/definitions/AttributeDelta" + } + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "Connector": { + "description": "The connect details.", + "type": "object", + "properties": { + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "id": { + "description": "The connector Id.", + "type": "string" + }, + "name": { + "description": "The connector name.", + "type": "string" + }, + "version": { + "description": "The connector version", + "type": "integer" + }, + "type": { + "description": "The connector type.", + "type": "string" + }, + "description": { + "description": "The connector description.", + "type": "string" + }, + "schemaXml": { + "description": "The schema xml for the connector.", + "type": "string" + }, + "passwordManagementSettings": { + "description": "The password management settings of the connector.", + "type": "object", + "items": { + "$ref": "#/definitions/PasswordManagementSettings" + } + }, + "passwordHashSyncConfiguration": { + "description": "The password hash synchronization configuration of the connector.", + "type": "object", + "items": { + "$ref": "#/definitions/PasswordHashSyncConfiguration" + } + }, + "timeCreated": { + "description": "The date and time when this connector was created.", + "type": "string", + "format": "date-time" + }, + "timeLastModified": { + "description": "The date and time when this connector was last modified.", + "type": "string", + "format": "date-time" + }, + "partitions": { + "description": "The partitions of the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/Partition" + } + }, + "runProfiles": { + "description": "The run profiles of the connector.", + "type": "array", + "items": { + "$ref": "#/definitions/RunProfile" + } + }, + "classesIncluded": { + "description": "The class inclusion list of the connector.", + "type": "array", + "items": { + "type": "string" + } + }, + "attributesIncluded": { + "description": "The attribute inclusion list of the connector.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Connectors": { + "description": "The list of connects for a service.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Connector" + } + } + } + }, + "ConnectorConnectionError": { + "description": "The connector connection error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The message for the connection error.", + "type": "string" + }, + "timeOccured": { + "description": "The time when the connection error occured.", + "type": "string", + "format": "date-time" + }, + "server": { + "description": "The server where the connection error happened.", + "type": "string" + } + } + }, + "ConnectorConnectionErrors": { + "description": "The list of connector connection errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorConnectionError" + } + } + } + }, + "ConnectorObjectError": { + "description": "The connector object error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The message for the object error.", + "type": "string" + }, + "entryNumber": { + "description": "The entry number for object error occured.", + "type": "integer" + }, + "lineNumber": { + "description": "The line number for the object error.", + "type": "integer" + }, + "columnNumber": { + "description": "The column number for the object error.", + "type": "integer" + }, + "dn": { + "description": "The distingished name of the object.", + "type": "string" + }, + "anchor": { + "description": "The name for the anchor of the object.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name of the object.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server side error details.", + "type": "string" + }, + "values": { + "description": "The value corresponding to attribute name.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ConnectorObjectErrors": { + "description": "The list of connector object errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorObjectError" + } + } + } + }, + "Credential": { + "description": "The credential for a given server.", + "type": "object", + "properties": { + "identifier": { + "description": "The credential identifier.", + "type": "string" + }, + "type": { + "description": "The type of credential.", + "type": "string" + }, + "credentialData": { + "description": "The credential data.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Credentials": { + "description": "The list of agent credentials.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Credential" + } + } + } + }, + "DataFreshnessDetails": { + "description": "The data freshness details for the server.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "Dimension": { + "description": "The connector object error.", + "type": "object", + "properties": { + "health": { + "description": "The health status for the domain controller.", + "type": "string", + "enum": [ + "Healthy", + "Warning", + "Error", + "NotMonitored", + "Missing" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "simpleProperties": { + "description": "List of service specific configuration properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "activeAlerts": { + "description": "The count of alerts that are currently active for the service.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information related to the service.", + "type": "string" + }, + "lastUpdated": { + "description": "The date or time , in UTC, when the service properties were last updated.", + "type": "string", + "format": "date-time" + }, + "displayName": { + "description": "The display name of the service.", + "type": "string" + }, + "resolvedAlerts": { + "description": "The total count of alerts that has been resolved for the service.", + "type": "integer" + }, + "signature": { + "description": "The signature of the service.", + "type": "string" + }, + "type": { + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "type": "string" + } + } + }, + "Dimensions": { + "description": "The list of dimensions.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "totalCount": { + "description": "The total count of dimensions.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "Display": { + "description": "Displays the details related to operations supported by Azure Active Directory Connect Health.", + "type": "object", + "properties": { + "description": { + "description": " The description for the operation.", + "type": "string" + }, + "operation": { + "description": "The details of the operation.", + "type": "string" + }, + "provider": { + "description": "The provider name.", + "type": "string" + } + } + }, + "ErrorCount": { + "description": "The error count details.", + "type": "object", + "properties": { + "errorBucket": { + "description": "The error bucket.", + "type": "string" + }, + "count": { + "description": "The error count.", + "type": "integer" + }, + "truncated": { + "description": "Indicates if the error count is truncated or not.", + "type": "boolean" + } + } + }, + "ErrorCounts": { + "description": "The list of error counts.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorCount" + } + } + } + }, + "ErrorDetail": { + "description": "The error details.", + "type": "object", + "properties": { + "description": { + "description": "The error description.", + "type": "string" + }, + "kbUrl": { + "description": "The knowledge base article url which contains more information about the error.", + "type": "string" + }, + "detail": { + "description": "Additional details related to the error.", + "type": "string" + }, + "objectsWithSyncError": { + "description": "The list of objects with sync errors.", + "$ref": "#/definitions/ObjectWithSyncError" + }, + "objectWithSyncError": { + "description": " The object with sync error.", + "$ref": "#/definitions/MergedExportError" + } + } + }, + "ExportError": { + "description": "The export error details.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "errorCode": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The export error message.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server error detail.", + "type": "string" + }, + "timeFirstOccured": { + "description": "The date and time when the export error first occured.", + "type": "string", + "format": "date-time" + }, + "retryCount": { + "description": "The retry count.", + "type": "integer" + }, + "csObjectId": { + "description": "The cloud object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + }, + "minLimit": { + "description": "The minimum limit.", + "type": "string" + }, + "maxLimit": { + "description": "The maximum limit.", + "type": "string" + }, + "cloudAnchor": { + "description": "The name of the cloud anchor.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "attributeMultiValue": { + "description": "Indicates if the attribute is multi valued or not.", + "type": "boolean" + }, + "objectIdConflict": { + "description": "The object Id with which there was an attribute conflict.", + "type": "string" + }, + "samAccountName": { + "description": "The SAM account name.", + "type": "string" + }, + "adObjectType": { + "description": "The AD object type", + "type": "string" + }, + "adObjectGuid": { + "description": "The AD object guid.", + "type": "string" + }, + "adDisplayName": { + "description": "The display name for the AD object.", + "type": "string" + }, + "adSourceOfAuthority": { + "description": "The source of authority for the AD object.", + "type": "string" + }, + "adSourceAnchor": { + "description": "The AD source anchor.", + "type": "string" + }, + "adUserPrincipalName": { + "description": "The user principal name for the AD object.", + "type": "string" + }, + "adDistinguishedName": { + "description": "The distinguished name for the AD object.", + "type": "string" + }, + "adMail": { + "description": "The email for the AD object.", + "type": "string" + }, + "timeOccured": { + "description": "The date and time of occurance.", + "type": "string", + "format": "date-time" + }, + "aadObjectType": { + "description": "The AAD side object type.", + "type": "string" + }, + "aadObjectGuid": { + "description": "The AAD side object guid.", + "type": "string" + }, + "aadDisplayName": { + "description": "The AAD side display name", + "type": "string" + }, + "aadSourceOfAuthority": { + "description": "The AAD side source of authority for the object.", + "type": "string" + }, + "aadUserPrincipalName": { + "description": "The AAD side user principal name.", + "type": "string" + }, + "aadDistringuishedName": { + "description": "The AAD side distinguished name for the object.", + "type": "string" + }, + "aadMail": { + "description": "The AAD side email for the object.", + "type": "string" + }, + "lastDirSyncTime": { + "description": "The date and time of last sync run.", + "type": "string", + "format": "date-time" + }, + "modifiedAttributeValue": { + "description": "The modified atttribute value.", + "type": "string" + } + } + }, + "ExportErrors": { + "description": "The list of export errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ExportError" + } + } + } + }, + "ErrorReportUsersEntry": { + "description": "The bad password login attempt details.", + "type": "object", + "properties": { + "userId": { + "description": "The user ID value.", + "type": "string" + }, + "ipAddress": { + "description": "The Ip address corresponding to the last error event.", + "type": "string" + }, + "lastUpdated": { + "description": "The date and time when the last error event was logged.", + "type": "string", + "format": "date-time" + }, + "uniqueIpAddresses": { + "description": "The list of unique IP addresses.", + "type": "string" + }, + "totalErrorAttempts": { + "description": "The total count of specific error events.", + "type": "integer" + } + } + }, + "ErrorReportUsersEntries": { + "description": "The list of bad password log in attempt entries.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorReportUsersEntry" + } + } + } + }, + "ExportStatus": { + "description": "The details of the export status.", + "type": "object", + "properties": { + "serviceId": { + "description": "The id of the service for whom the export status is being reported.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id for whom the export status is being reported.", + "type": "string", + "format": "uuid" + }, + "endTime": { + "description": "The date and time when the export ended.", + "type": "string", + "format": "date-time" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + } + } + }, + "ExportStatuses": { + "description": "The list of export statuses.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ExportStatus" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "ExtensionErrorInfo": { + "description": "The extension error details.", + "type": "object", + "properties": { + "extensionName": { + "description": "The extension name.", + "type": "string" + }, + "extensionContext": { + "description": "The extension context.", + "type": "string" + }, + "callStack": { + "description": "The call stack for the error.", + "type": "string" + } + } + }, + "ForestSummary": { + "description": "The forest summary for an ADDS domain.", + "type": "object", + "properties": { + "forestName": { + "description": "The forest name.", + "type": "string" + }, + "domainCount": { + "description": "The domain count.", + "type": "integer" + }, + "siteCount": { + "description": "The site count.", + "type": "integer" + }, + "monitoredDcCount": { + "description": "The number of domain controllers that are monitored by Azure Active Directory Connect Health.", + "type": "integer" + }, + "totalDcCount": { + "description": "The total domain controllers.", + "type": "integer" + }, + "domains": { + "description": "The list of domain controller names.", + "type": "array", + "items": { + "type": "string" + } + }, + "sites": { + "description": "The list of site names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GlobalConfiguration": { + "description": "The global configuration settings.", + "type": "object", + "properties": { + "version": { + "description": "The version for the global configuration.", + "type": "integer" + }, + "schemaXml": { + "description": "The schema for the configuration.", + "type": "string" + }, + "passwordSyncEnabled": { + "description": "Indicates if password sync is enabled or not.", + "type": "boolean" + }, + "numSavedPwdEvent": { + "description": "The number of saved password events.", + "type": "integer" + }, + "featureSet": { + "description": "The list of additional feature sets.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "GlobalConfigurations": { + "description": "The list of global configurations.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/GlobalConfiguration" + } + } + } + }, + "HelpLink": { + "description": "The help link which contains more information related to an alert.", + "type": "object", + "properties": { + "title": { + "description": "The title for the link.", + "type": "string" + }, + "url": { + "description": "The url for the help document.", + "type": "string" + } + } + }, + "Hotfix": { + "description": "The details of the hotfix installed in the server.", + "type": "object", + "properties": { + "kbName": { + "description": "The name of the hotfix KB.", + "type": "string" + }, + "link": { + "description": "The link to the KB Article.", + "type": "string" + }, + "installedDate": { + "description": "The date and time, in UTC, when the KB was installed in the server.", + "type": "string", + "format": "date-time" + } + } + }, + "Hotfixes": { + "description": "The list of hotfixes installed in the server.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Hotfix" + } + } + } + }, + "ImportErrors": { + "description": "The list of import errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ImportError" + } + } + } + }, + "ImportError": { + "description": "The import error details.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string" + }, + "timeOccurred": { + "description": "The time when the import error occurred.", + "type": "string", + "format": "date-time" + }, + "timeFirstOccurred": { + "description": "The time when the import error first occurred.", + "type": "string", + "format": "date-time" + }, + "retryCount": { + "description": "The retry count.", + "type": "integer" + }, + "algorithmStepType": { + "description": "The operation type specific to error reporting.", + "type": "string", + "enum": [ + "Undefined", + "Staging", + "ConnectorFilter", + "Join", + "Projection", + "ImportFlow", + "Provisioning", + "ValidateConnectorFilter", + "Deprovisioning", + "ExportFlow", + "MvDeletion", + "Recall", + "MvObjectTypeChange" + ], + "x-ms-enum": { + "name": "AlgorithmStepType", + "modelAsString": true + } + }, + "changeNotReimported": { + "description": "The change details that is not re-imported.", + "$ref": "#/definitions/ChangeNotReimported" + }, + "extensionErrorInfo": { + "description": "The extension error information.", + "$ref": "#/definitions/ExtensionErrorInfo" + }, + "ruleErrorInfo": { + "description": "The error details in legacy rule processing.", + "$ref": "#/definitions/RuleErrorInfo" + }, + "csObjectId": { + "description": "The object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "InboundReplicationNeighbor": { + "description": "The replication summary for the domain controller inbound neighbor.", + "type": "object", + "properties": { + "sourceDomainController": { + "description": "The name of the source domain controller.", + "type": "string" + }, + "consecutiveFailureCount": { + "description": "The number of consecutive faulire counts.", + "type": "integer" + }, + "namingContext": { + "description": "The naming context.", + "type": "string" + }, + "status": { + "description": "The health status for the domain controller", + "type": "integer" + }, + "lastAttemptedSync": { + "description": "The last time a sync was attempted on the domain controller.", + "type": "string", + "format": "date-time" + }, + "lastSuccessfulSync": { + "description": "The last time when a successful sync happened.", + "type": "string", + "format": "date-time" + }, + "lastErrorCode": { + "description": "The last error code.", + "type": "integer" + }, + "lastErrorMessage": { + "description": "The error message of the last error.", + "type": "string" + }, + "errorTitle": { + "description": "The error title.", + "type": "string" + }, + "errorDescription": { + "description": "The error description.", + "type": "string" + }, + "fixLink": { + "description": "The link for the fix of the error.", + "type": "string" + }, + "fixDetails": { + "description": "The details of the fix.", + "type": "string" + }, + "additionalInfo": { + "description": "The additional details.", + "type": "string" + } + } + }, + "InboundReplicationNeighbors": { + "description": "The list of replication summary for the domain controller inbound neighbor.", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The details of inbound replication neighbors.", + "items": { + "$ref": "#/definitions/InboundReplicationNeighbor" + } + } + } + }, + "Item": { + "description": "The key value pair for properties.", + "type": "object", + "properties": { + "key": { + "description": "The key for the property.", + "type": "string" + }, + "value": { + "description": "The value for the key.", + "type": "string" + } + } + }, + "Items": { + "description": "The list of key value properties.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + } + }, + "MergedExportError": { + "description": "The merged export error.", + "type": "object", + "properties": { + "id": { + "description": "The error Id.", + "type": "string" + }, + "incomingObjectDisplayName": { + "description": "The incoming object display name.", + "type": "string" + }, + "incomingObjectType": { + "description": "The incoming object type.", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name", + "type": "string" + }, + "type": { + "description": "The type of the error.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "timeOccurred": { + "description": "The date and time when the error occurred.", + "type": "string", + "format": "date-time" + }, + "timeFirstOccurred": { + "description": "The time when the error first occurred.", + "type": "string", + "format": "date-time" + }, + "csObjectId": { + "description": " the cs object Id.", + "type": "string" + }, + "dn": { + "description": "the DN of the object.", + "type": "string" + }, + "incomingObject": { + "description": "The incoming object details.", + "$ref": "#/definitions/AssociatedObject" + }, + "existingObject": { + "description": "The existing object", + "$ref": "#/definitions/AssociatedObject" + }, + "modifiedOrRemovedAttributeValue": { + "description": "The modified or removed attribute vlaue.", + "type": "string" + }, + "runStepResultId": { + "description": "The run step result Id.", + "type": "string", + "format": "uuid" + }, + "samAccountName": { + "description": "The sam account name.", + "type": "string" + }, + "serverErrorDetail": { + "description": "The server error details.", + "type": "string" + }, + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + }, + "mergedEntityId": { + "description": "The merged entity Id.", + "type": "string", + "format": "uuid" + }, + "createdDate": { + "description": "The date and time, in UTC, when the error was created.", + "type": "string", + "format": "date-time" + }, + "exportErrorStatus": { + "description": "The export error status.", + "type": "integer" + } + } + }, + "MergedExportErrors": { + "description": "The list of export errors.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MergedExportError" + } + } + } + }, + "MetricGroup": { + "description": " The metric group details.", + "type": "object", + "properties": { + "key": { + "description": "The key for the group.", + "type": "string" + }, + "displayName": { + "description": "The display name for the group.", + "type": "string" + }, + "invisibleForUi": { + "description": "indicates if the metric group is displayed in Azure Active Directory Connect Health UI.", + "type": "boolean" + } + } + }, + "Metrics": { + "description": "The list of metric items.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + }, + "totalCount": { + "description": "The total count of metrics.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "MetricMetadata": { + "description": "The metric meta data", + "type": "object", + "properties": { + "metricsProcessorClassName": { + "description": "The name of the class which retrieve and process the metric.", + "type": "string" + }, + "metricName": { + "description": "The metric name", + "type": "string" + }, + "groupings": { + "description": "The groupings for the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricGroup" + } + }, + "displayName": { + "description": "The display name for the metric.", + "type": "string" + }, + "valueKind": { + "description": "Indicates if the metrics is a rate,value, percent or duration type.", + "type": "string" + }, + "minValue": { + "description": "The minimun value.", + "type": "integer" + }, + "maxValue": { + "description": "The maximum value.", + "type": "integer" + }, + "kind": { + "description": "Indicates whether the dashboard to represent the metric is a line, bar,pie, area or donut chart.", + "type": "string" + }, + "isDefault": { + "description": "Indicates if the metric is a default metric or not.", + "type": "boolean" + }, + "isPerfCounter": { + "description": "Indicates if the metric is a performance counter metric or not.", + "type": "boolean" + }, + "isDevOps": { + "description": "Indicates if the metric is visible to DevOps or not.", + "type": "boolean" + } + } + }, + "MetricMetadataList": { + "description": "The list of metric metadata.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricMetadata" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "MetricSet": { + "description": " The set of metric values. Example of a MetricSet are Values of token requests for a Server1 or RelyingParty1.", + "type": "object", + "properties": { + "setName": { + "description": "The name of the set.", + "type": "string" + }, + "values": { + "description": "The list of the metric values.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "MetricSets": { + "description": "The metrics data represented set.", + "type": "object", + "properties": { + "sets": { + "description": "The list of metric set.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSet" + } + }, + "timeStamps": { + "description": "The list of timestamps for each metric in the metric set.", + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + } + } + }, + "ModuleConfiguration": { + "description": "The module configuration as required by the Agent service.", + "type": "object", + "properties": { + "agentService": { + "description": "The name of agent service.", + "type": "string" + }, + "moduleName": { + "description": "The name of the module for which the configuration is applicable.", + "type": "string" + }, + "properties": { + "description": "The key value pairs of properties required for configuration.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ModuleConfigurations": { + "description": "The list of module configurations.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ModuleConfiguration" + } + } + } + }, + "ObjectWithSyncError": { + "description": "The objects withg sync errors.", + "type": "object", + "properties": { + "sourceOfAuthority": { + "description": "The source of authority.", + "type": "string" + }, + "displayName": { + "description": "The display name.", + "type": "string" + }, + "objectType": { + "description": "The object type.", + "type": "string" + }, + "attributeName": { + "description": "The attribute name.", + "type": "string" + }, + "attributeValue": { + "description": "The attribute value.", + "type": "string" + }, + "modififedValue": { + "description": "The modified value.", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name.", + "type": "string" + }, + "objectGuid": { + "description": "The object guid.", + "type": "string" + }, + "attributeMultiValues": { + "description": "Indicates if the atttibute is multi-valued or not.", + "type": "boolean" + }, + "minLimit": { + "description": "The minimum limit.", + "type": "string" + }, + "maxLimit": { + "description": "The maximum limit.", + "type": "string" + }, + "distinguishedName": { + "description": "The distinguished name.", + "type": "string" + }, + "mail": { + "description": "The email.", + "type": "string" + }, + "timeOccured": { + "description": "The date and time of occurance.", + "type": "string", + "format": "date-time" + }, + "errorType": { + "description": "The error type.", + "type": "string" + }, + "sourceAnchor": { + "description": "The source anchor.", + "type": "string" + } + } + }, + "Operation": { + "description": "The details of the operation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation.", + "type": "string" + }, + "display": { + "description": "The display details for the operation.", + "type": "object", + "items": { + "$ref": "#/definitions/Display" + } + } + } + }, + "OperationListResponse": { + "description": "Lists all of the available REST API operations for Azure Active Directory Connect Health.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "List of operations supported by the Microsoft.ADHybridhHealthService resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "totalCount": { + "description": "The total count of opertaions.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token to get next set of operations.", + "type": "string" + } + + } + }, + "Partition": { + "description": "Describes the partition in Synchronization service.", + "type": "object", + "properties": { + "id": { + "description": "The partition Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name for the partition.", + "type": "string" + }, + "enabled": { + "description": "Indicates if the partition object is selected or not.", + "type": "boolean" + }, + "timeCreated": { + "description": "The date and time when the partition is created.", + "type": "string", + "format": "date-time" + }, + "timeLastModified": { + "description": "The time and date when the partition was last modified.", + "type": "string", + "format": "date-time" + }, + "partitionScope": { + "description": "The scope of the partition.", + "$ref": "#/definitions/PartitionScope" + }, + "name": { + "description": "The name of the partition.", + "type": "string" + }, + "isDomain": { + "description": "Indicates if the partition is a domain or not.", + "type": "boolean" + }, + "type": { + "description": "The partition type.", + "type": "string" + } + } + + }, + "PartitionScope": { + "description": "The connector partition scope.", + "type": "object", + "properties": { + "isDefault": { + "description": "Indicates if the partition scope is default or not.", + "type": "boolean" + }, + "objectClasses": { + "description": "The in-scope object classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "containersIncluded": { + "description": "The list of containers included.", + "type": "array", + "items": { + "type": "string" + } + }, + "containersExcluded": { + "description": "The list of containers excluded.", + "type": "array", + "items": { + "type": "string" + } + } + } + + }, + "PasswordManagementSettings": { + "description": "The password management settings.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates if the password extension is enabled.", + "type": "boolean" + }, + "extensionFilePath": { + "description": "The file path of the password management extension.", + "type": "string" + }, + "connectTo": { + "description": "Connection point of password management.", + "type": "string" + }, + "connectionTimeout": { + "description": "Connection timeoit for password extension.", + "type": "integer" + }, + "user": { + "description": "User to execute password extension.", + "type": "string" + }, + "supportedPasswordOperations": { + "description": "The supported password operations.", + "type": "string", + "enum": [ + "Undefined", + "Set", + "Change" + ], + "x-ms-enum": { + "name": "PasswordOperationTypes", + "modelAsString": true + } + }, + "maximumRetryCount": { + "description": "The maximum number of retries.", + "type": "integer" + }, + "retryIntervalInSeconds": { + "description": "The time between retries.", + "type": "integer" + }, + "requiresSecureConnection": { + "description": "Indicates if a secure connection is required for password management.", + "type": "boolean" + }, + "unlockAccount": { + "description": "Indicates if accounts should be unloacked when resetting password.", + "type": "boolean" + } + } + }, + "PasswordHashSyncConfiguration": { + "description": "The password has synchronization configuration settings.", + "type": "object", + "properties": { + "enabled": { + "description": "Indicates if the password hash synchronization configuration settings is enabled.", + "type": "boolean" + }, + "target": { + "description": "The target.", + "type": "string" + } + } + }, + "ReplicationDetailsList": { + "description": "The list of replication details.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationSummary" + } + }, + "totalCount": { + "description": "The total count of replication detail elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + } + }, + "ReplicationStatus": { + "description": " Replication summary for a domain controller.", + "type": "object", + "properties": { + "forestName": { + "description": "The forest name.", + "type": "string" + }, + "totalDcCount": { + "description": "The total numbe of domain controllers for a given forest.", + "type": "integer" + }, + "errorDcCount": { + "description": "The total number of domain controllers with error in a given forest.", + "type": "integer" + } + } + }, + "ReplicationSummary": { + "description": "The replication summary for a domain controller.", + "type": "object", + "properties": { + "targetServer": { + "description": "The domain controller name.", + "type": "string" + }, + "site": { + "description": "The site name for a given domain controller.", + "type": "string" + }, + "domain": { + "description": "The domain name for a given domain controller.", + "type": "string" + }, + "status": { + "description": "The health status for a domain controller.", + "type": "integer" + }, + "lastAttemptedSync": { + "description": "The last time when a sync was attempted for a given domain controller.", + "type": "string", + "format": "date-time" + }, + "lastSuccessfulSync": { + "description": "The time when the last successful sync happened for a given domain controller.", + "type": "string", + "format": "date-time" + }, + "inboundNeighborCollection": { + "description": "List of individual domain controller neighbor's inbound replication status.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundReplicationNeighbor" + } + } + } + }, + "ReplicationSummaryList": { + "description": "The list of replication summary details.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationSummary" + } + } + } + }, + "Result": { + "description": "The result for an operation.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "boolean" + } + } + }, + "RuleErrorInfo": { + "description": "The error details in legacy rule processing.", + "type": "object", + "properties": { + "attributeMapping": { + "description": "The attribute mapping details.", + "$ref": "#/definitions/AttributeMapping" + }, + "connectorId": { + "description": "The connector Id.", + "type": "string" + }, + "connectorName": { + "description": "The connector name.", + "type": "string" + }, + "csObjectId": { + "description": "The object Id.", + "type": "string" + }, + "dn": { + "description": "The distinguished name.", + "type": "string" + } + } + }, + "RunStep": { + "description": "The run step for a run profile.", + "type": "object", + "properties": { + "batchSize": { + "description": "The batch size used by the run step.", + "type": "integer" + }, + "objectProcessLimit": { + "description": "The obect processing limit.", + "type": "integer" + }, + "objectDeleteLimit": { + "description": "The object deletion limit.", + "type": "integer" + }, + "pageSize": { + "description": "The page size of the run step.", + "type": "integer" + }, + "partitionId": { + "description": "The Id of the partition that a current run setp operation is executing.", + "type": "string" + }, + "operationType": { + "description": "The run step operation types.", + "type": "integer" + }, + "timeout": { + "description": "The operation timeout.", + "type": "integer" + } + } + }, + "RunProfile": { + "description": "Describes the run profile.", + "type": "object", + "properties": { + "id": { + "description": "The run profile Id.", + "type": "string" + }, + "name": { + "description": "The run profile name", + "type": "string" + }, + "runSteps": { + "description": "The run steps of the run profile.", + "type": "array", + "items": { + "$ref": "#/definitions/RunStep" + } + } + } + }, + "RunProfiles": { + "description": "The list of run profiles.", + "type": "object", + "properties": { + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/RunProfile" + } + } + } + }, + "ServiceConfiguration": { + "description": "The service configuration", + "type": "object", + "properties": { + "version": { + "description": "The version of the sync service.", + "type": "string" + }, + "serviceType": { + "description": "The service type of the server.", + "type": "integer" + }, + "serviceAccount": { + "description": "The service account.", + "type": "string" + }, + "sqlServer": { + "description": "The SQL server information.", + "type": "string" + }, + "sqlVersion": { + "description": "The SQL version.", + "type": "string" + }, + "sqlEdition": { + "description": "The SQL edition", + "type": "string" + }, + "sqlInstance": { + "description": "The SQL instance details.", + "type": "string" + }, + "sqlDatabaseName": { + "description": "The SQL database.", + "type": "string" + }, + "sqlDatabaseSize": { + "description": "The SQL database size.", + "type": "integer" + } + } + }, + "ServiceProperties": { + "description": "The service properties for a given service.", + "type": "object", + "properties": { + "id": { + "description": "The id of the service.", + "type": "string" + }, + "activeAlerts": { + "description": "The count of alerts that are currently active for the service.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information related to the service.", + "type": "string" + }, + "createdDate": { + "description": "The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "customNotificationEmails": { + "description": "The list of additional emails that are configured to recieve notifications about the service.", + "type": "array", + "items": { + "type": "string" + } + }, + "disabled": { + "description": "Indicates if the service is disabled or not.", + "type": "boolean" + }, + "displayName": { + "description": "The display name of the service.", + "type": "string" + }, + "health": { + "description": "The health of the service.", + "type": "string" + }, + "lastDisabled": { + "description": "The date and time, in UTC, when the service was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date or time , in UTC, when the service properties were last updated.", + "type": "string", + "format": "date-time" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "notificationEmailEnabled": { + "description": "Indicates if email notification is enabled or not.", + "type": "boolean" + }, + "notificationEmailEnabledForGlobalAdmins": { + "description": "Indicates if email notification is enabled for global administrators of the tenant.", + "type": "boolean" + }, + "notificationEmailsEnabledForGlobalAdmins": { + "description": "Indicates if email notification is enabled for global administrators of the tenant.", + "type": "boolean" + }, + "notificationEmails": { + "description": "The list of emails to whom service notifications will be sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "originalDisabledState": { + "description": "Gets the original disable state.", + "type": "boolean" + }, + "resolvedAlerts": { + "description": "The total count of alerts that has been resolved for the service.", + "type": "integer" + }, + "serviceId": { + "description": "The id of the service.", + "type": "string" + }, + "serviceName": { + "description": "The name of the service.", + "type": "string" + }, + "signature": { + "description": "The signature of the service.", + "type": "string" + }, + "simpleProperties": { + "description": "List of service specific configuration properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Items" + } + }, + "tenantId": { + "description": "The id of the tenant to which the service is registered to.", + "type": "string" + }, + "type": { + "description": "The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService.", + "type": "string" + } + } + }, + "Services": { + "description": "The list of services for a given onboarded tenant.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProperties" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "ServiceMember": { + "description": "The server properties for a given service.", + "type": "object", + "properties": { + "serviceMemberId": { + "description": "The id of the server.", + "type": "string" + }, + "serviceId": { + "description": "The service id to whom this server belongs.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id to whom this server belongs.", + "type": "string" + }, + "activeAlerts": { + "description": "The total number of alerts that are currently active for the server.", + "type": "integer" + }, + "additionalInformation": { + "description": "The additional information, if any, for the server.", + "type": "string" + }, + "createdDate": { + "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "type": "string", + "format": "date-time" + }, + "dimensions": { + "description": "The server specific configuration related dimensions.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "disabled": { + "description": "Indicates if the server is disabled or not. ", + "type": "boolean" + }, + "disabledReason": { + "description": "The reason for disabling the server.", + "type": "integer" + }, + "installedQfes": { + "description": "The list of installed QFEs for the server.", + "type": "object", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "lastDisabled": { + "description": "The date and time , in UTC, when the server was last disabled.", + "type": "string", + "format": "date-time" + }, + "lastReboot": { + "description": "The date and time, in UTC, when the server was last rebooted.", + "type": "string", + "format": "date-time" + }, + "lastServerReportedMonitoringLevelChange": { + "description": "The date and time, in UTC, when the server's data monitoring configuration was last changed.", + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "description": "The date and time, in UTC, when the server proeprties were last updated.", + "type": "string", + "format": "date-time" + }, + "machineId": { + "description": "The id of the machine.", + "type": "string" + }, + "machineName": { + "description": "The name of the server.", + "type": "string" + }, + "monitoringConfigurationsComputed": { + "description": "The monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "monitoringConfigurationsCustomized": { + "description": "The customized monitoring configuration of the server which determines what activities are monitored by Azure Active Directory Connect Health.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "osName": { + "description": "The name of the operating system installed in the machine.", + "type": "string" + }, + "osVersion": { + "description": "The version of the operating system installed in the machine.", + "type": "string" + }, + "properties": { + "description": "Server specific properties.", + "type": "object", + "items": { + "$ref": "#/definitions/Item" + } + }, + "recommendedQfes": { + "description": "The list of recommended hotfixes for the server.", + "type": "object", + "items": { + "$ref": "#/definitions/Hotfix" + } + }, + "resolvedAlerts": { + "description": "The total count of alerts that are resolved for this server.", + "type": "integer" + }, + "role": { + "description": "The service role that is being monitored in the server.", + "type": "string" + }, + "serverReportedMonitoringLevel": { + "description": "The monitoring level reported by the server.", + "type": "string", + "enum": [ + "Partial", + "Full", + "Off" + ], + "x-ms-enum": { + "name": "MonitoringLevel", + "modelAsString": false + } + }, + "status": { + "description": "The health status of the server.", + "type": "string" + } + } + }, + "ServiceMembers": { + "description": "The list of servers that are onboarded for a given service.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The value returned by the operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceMember" + } + }, + "totalCount": { + "description": "The total count of service elements.", + "type": "integer" + }, + "continuationToken": { + "description": "The continuation token for paginated calls.", + "type": "string" + } + } + }, + "TabularExportError": { + "description": "The details for export error.", + "type": "object", + "properties": { + "serviceId": { + "description": "The service Id.", + "type": "string", + "format": "uuid" + }, + "serviceMemberId": { + "description": "The server Id.", + "type": "string", + "format": "uuid" + }, + "mergedEntityId": { + "description": "The merged entity Id.", + "type": "string", + "format": "uuid" + }, + "tabularExportErrorData": { + "description": "The export error data.", + "type": "string" + } + } + }, + "Tenant": { + "description": "The details of the onboarded tenant.", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "The Id of the tenant." + }, + "aadLicense": { + "type": "string", + "description": "The Azure Active Directory license of the tenant." + }, + "aadPremium": { + "type": "boolean", + "description": "Indicate if the tenant has Azure Active Directory Premium license or not." + }, + "agentAutoUpdate": { + "type": "boolean", + "description": "Indicates if the tenant is configured to automatically receive updates for Azure Active Directory Connect Health client side features." + }, + "alertSuppressionTimeInMins": { + "type": "integer", + "description": "The time in minutues after which an alert will be autosupressed." + }, + "consentedToMicrosoftDevOps": { + "type": "boolean", + "description": "Indicates if the tenant data can be seen by Microsoft through Azure portal." + }, + "countryLetterCode": { + "type": "string", + "description": "The country letter code of the tenant." + }, + "createdDate": { + "type": "string", + "format": "date-time", + "description": "The date, in UTC, when the tenant was onboarded to Azure Active Directory Connect Health." + }, + "devOpsTtl": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, till when the tenant data can be seen by Microsoft through Azure portal." + }, + "disabled": { + "type": "boolean", + "description": "Indicates if the tenant is disabled in Azure Active Directory Connect Health." + }, + "disabledReason": { + "type": "integer", + "description": "The reason due to which the tenant was disabled in Azure Active Directory Connect Health." + }, + "globalAdminsEmail": { + "type": "object", + "items": { + "type": "string" + }, + "description": "The list of golbal administrators for the tenant." + }, + "initialDomain": { + "type": "string", + "description": "The initial domain of the tenant." + }, + "lastDisabled": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, when the tenant was last disabled in Azure Active Directory Connect Health." + }, + "lastVerified": { + "type": "string", + "format": "date-time", + "description": "The date and time, in UTC, when the tenant onboarding status in Azure Active Directory Connect Health was last verified." + }, + "onboardingAllowed": { + "type": "boolean", + "description": "Indicates if the tenant is allowed to onboard to Azure Active Directory Connect Health." + }, + "onboarded": { + "type": "boolean", + "description": "Indicates if the tenant is already onboarded to Azure Active Directory Connect Health." + }, + "pksCertificate": { + "type": "object", + "description": "The certificate associated with the tenant to onboard data to Azure Active Directory Connect Health." + }, + "privatePreviewTenant": { + "type": "boolean", + "description": "Indicates if the tenant has signed up for private preview of Azure Active Directory Connect Health features." + }, + "tenantInQuarantine": { + "type": "boolean", + "description": "Indicates if data collection for this tenant is disabled or not." + }, + "tenantName": { + "type": "string", + "description": "The name of the tenant." + } + } + }, + "TenantOnboardingDetails": { + "description": "The tenant onboarding details.", + "type": "object", + "properties": { + "tenantOnboarded": { + "description": "Indicates if the tenant is onboarded to Azure Active Directory Connect Health or not.", + "type": "boolean" + }, + "onboardingDisplayUrl": { + "description": "The display url, to help tenant navigate or onboard to Azure Active Directory Connect Health blade, based on tenant onboarding status.", + "type": "string" + } + } + }, + "UserPreference": { + "description": " The user preference for a given feature.", + "type": "object", + "properties": { + "metricNames": { + "description": "The name of the metric.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ValueDelta": { + "description": "The value of the delta.", + "type": "object", + "properties": { + "operationType": { + "description": "The operation type.", + "type": "string", + "enum": [ + "Undefined", + "Add", + "Update", + "Delete" + ], + "x-ms-enum": { + "name": "ValueDeltaOperationType", + "modelAsString": true + } + }, + "value": { + "description": "The value of the delta.", + "type": "string" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The version of the API to be used with the client request.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ "user_impersonation" ] + } + ] +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json index b573322a2610..128090a0f1f7 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddAlertFeedback.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "alertFeedback": [ - { - "level": "Error", - "state": "Active", - "shortName": "AlertShortName", - "feeback": "Like", - "comment": "SampleComment", - "consentedToShare": false, - "serviceMemberId": "SampleServiceMemberId" - } - ] , - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "level": "Error", - "state": "Active", - "createdDate": "2018-04-30T23:28:19.6001893Z", - "shortName": "AlertShortName", - "feedback": "Like", - "comment": "SampleComment", - "consentedToShare": false, - "serviceMemberId": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "alertFeedback": [ + { + "level": "Error", + "state": "Active", + "shortName": "AlertShortName", + "feeback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": "SampleServiceMemberId" + } + ] , + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "level": "Error", + "state": "Active", + "createdDate": "2018-04-30T23:28:19.6001893Z", + "shortName": "AlertShortName", + "feedback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json index 3ec7d3509e4c..df13a835b890 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddService.json @@ -1,74 +1,74 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "service": { - "activeAlerts": 0, - "additionalInformation": "SampleAdditionalInformation", - "createdDate": "2017-04-07T16:03:06.9053139Z", - "customNotificationEmails": [ - "email1", - "email2" - ], - "disabled": false, - "displayName": "sample display name", - "health": "Healthy", - "lastDisabled": "2017-05-07T16:03:06.9053139Z", - "lastUpdated": "2018-04-30T00:55:33.5799677Z", - "monitoringConfigurationsComputed": "samplemonitoringConfig", - "monitoringConfigurationsCustomized": "samplemonitoringConfig", - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalAdmins": true, - "notificationEmails": [ - "email3", - "email4" - ], - "notificationEmailsEnabledForGlobalAdmins": false, - "resolvedAlerts": 0, - "serviceId": "12345678-1234-1234-1234-123456789000", - "serviceName": "sampleServiceName", - "signature": "SampleSignature", - "simpleProperties": null, - "tenantId": "12345678-1234-1234-1234-123456789000", - "type": "AadSyncService", - "originalDisabledState": false, - "id": "ServiceId" - }, - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "activeAlerts": 0, - "additionalInformation": "SampleAdditionalInformation", - "createdDate": "2017-04-07T16:03:06.9053139Z", - "customNotificationEmails": [ - "email1", - "email2" - ], - "disabled": false, - "displayName": "sample display name", - "health": "Healthy", - "lastDisabled": "2017-05-07T16:03:06.9053139Z", - "lastUpdated": "2018-04-30T00:55:33.5799677Z", - "monitoringConfigurationsComputed": "samplemonitoringConfig", - "monitoringConfigurationsCustomized": "samplemonitoringConfig", - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalAdmins": true, - "notificationEmails": [ - "email3", - "email4" - ], - "notificationEmailsEnabledForGlobalAdmins": false, - "resolvedAlerts": 0, - "serviceId": "12345678-1234-1234-1234-123456789000", - "serviceName": "sampleServiceName", - "signature": "SampleSignature", - "simpleProperties": null, - "tenantId": "12345678-1234-1234-1234-123456789000", - "type": "AadSyncService", - "originalDisabledState": false, - "id": "ServiceId" - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "service": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json index 152248f39c5c..4265a2848e6d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddServiceMembers.json @@ -1,122 +1,122 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMember": { - "lastReboot": "2018-04-28T11:33:07.484Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-05-01T00:15:32.5476494Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T23:17:00.511864Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "machineId": "SampleMachineId", - "machineName": "SampleMachineName", - "role": "AdfsServer_30", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "osVersion", - "osName": "osName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - }, - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "lastReboot": "2018-04-28T11:33:07.484Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-05-01T00:15:32.5476494Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T23:17:00.511864Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "machineId": "SampleMachineId", - "machineName": "SampleMachineName", - "role": "AdfsServer_30", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "osVersion", - "osName": "osName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMember": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json index 24fcb7eeba6f..1d9a70d84ba8 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddUserPreference.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "featureName": "SampleFeatureName", - "setting": [ - { - "metricNames": [ - "UserPreference1", - "UserPreference2" - ] - } - ], - "api-version": "2014-01-01" - }, - "responses": { - "200": {} - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "setting": [ + { + "metricNames": [ + "UserPreference1", + "UserPreference2" + ] + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json index c48d90f0e049..84e9a088aba0 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json @@ -1,89 +1,89 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "isGroupbySite": true, - "takeCount": "1", - "nextPartitionKey": " ", - "nextRowKey": " ", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "domainName": "sampleDomainName", - "siteName": "Default-First-Site-Name", - "addsRoles": [ - "sampleRole" - ], - "gcReachable": true, - "isAdvertising": true, - "pdcReachable": true, - "sysvolState": true, - "dcTypes": [ - "GC" - ], - "lastReboot": "2018-04-28T23:17:00.511864Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-04-30T18:00:41.6956022Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T23:17:00.511864Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "00000000-0000-0000-0000-000000000000", - "serviceId": "serviceIdGuid", - "serviceMemberId": "ServiceMemberIdGuid", - "machineId": "machineIdGuid", - "machineName": "sampleMachineName", - "role": "SampleRole", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "osVersion", - "osName": "osName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "isGroupbySite": true, + "takeCount": "1", + "nextPartitionKey": " ", + "nextRowKey": " ", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "domainName": "sampleDomainName", + "siteName": "Default-First-Site-Name", + "addsRoles": [ + "sampleRole" + ], + "gcReachable": true, + "isAdvertising": true, + "pdcReachable": true, + "sysvolState": true, + "dcTypes": [ + "GC" + ], + "lastReboot": "2018-04-28T23:17:00.511864Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-04-30T18:00:41.6956022Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "00000000-0000-0000-0000-000000000000", + "serviceId": "serviceIdGuid", + "serviceMemberId": "ServiceMemberIdGuid", + "machineId": "machineIdGuid", + "machineName": "sampleMachineName", + "role": "SampleRole", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json index bd7df1660aa4..7817eb1a43ec 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsConfiguration.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "key": "Forest name", - "value": "SampleForestName" - }, - { - "key": "Functional Level", - "value": "Sample Functional Level." - } - ], - "nextLink": null, - "totalCount": 1, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "Forest name", + "value": "SampleForestName" + }, + { + "key": "Functional Level", + "value": "Sample Functional Level." + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json index 979c896780ee..a1797b28659a 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddsServiceMembers.json @@ -1,85 +1,85 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "domainName": "sampleDomainName", - "siteName": "Default-First-Site-Name", - "addsRoles": [ - "sampleRole" - ], - "gcReachable": true, - "isAdvertising": true, - "pdcReachable": true, - "sysvolState": true, - "dcTypes": [ - "GC" - ], - "lastReboot": "2018-04-28T23:17:00.511864Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-04-30T18:00:41.6956022Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T11:33:07.484Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "00000000-0000-0000-0000-000000000000", - "serviceId": "serviceIdGuid", - "serviceMemberId": "ServiceMemberIdGuid", - "machineId": "machineIdGuid", - "machineName": "sampleMachineName", - "role": "SampleRole", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "osVersion", - "osName": "osName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "domainName": "sampleDomainName", + "siteName": "Default-First-Site-Name", + "addsRoles": [ + "sampleRole" + ], + "gcReachable": true, + "isAdvertising": true, + "pdcReachable": true, + "sysvolState": true, + "dcTypes": [ + "GC" + ], + "lastReboot": "2018-04-28T23:17:00.511864Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-04-30T18:00:41.6956022Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "00000000-0000-0000-0000-000000000000", + "serviceId": "serviceIdGuid", + "serviceMemberId": "ServiceMemberIdGuid", + "machineId": "machineIdGuid", + "machineName": "sampleMachineName", + "role": "SampleRole", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json index 416e472d17bb..d3703fb87fc0 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json @@ -1,74 +1,74 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "state": "Active", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "alertId": "SampleAlertId", - "level": "Error", - "state": "Active", - "shortName": "SampleAlertName", - "displayName": "SampleAlertDisplayName", - "description": "SampleAlertDescription", - "remediation": "SampleAlertRemediation", - "relatedLinks": [ - { - "title": "SampleTitle1", - "url": "SampleUrl1" - }, - { - "title": "SampleTilte2", - "url": "SampleUrl2" - } - ], - "scope": "SampleScope", - "additionalInformation": [ - { - "titleName": "SampleAdditionalInfo", - "titleValue": "SampleTitle", - "properties": [ - { - "key": "Property1", - "value": "Value1" - }, - { - "key": "Property2", - "value": "Value2" - } - ], - "hasProperties": true - } - ], - "createdDate": "2018-04-10T03:12:23.4408944Z", - "resolvedDate": "2018-04-10T03:12:23.4408944Z", - "lastUpdated": "2018-04-30T19:24:42.1946017Z", - "monitorRoleType": "SampleRole", - "activeAlertProperties": [ - { - "key": "ActiveProperty1", - "value": "Value1" - } - ], - "resolvedAlertProperties": [ - { - "key": "ResolvedProperty1", - "value": "Value1" - } - ], - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "state": "Active", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "alertId": "SampleAlertId", + "level": "Error", + "state": "Active", + "shortName": "SampleAlertName", + "displayName": "SampleAlertDisplayName", + "description": "SampleAlertDescription", + "remediation": "SampleAlertRemediation", + "relatedLinks": [ + { + "title": "SampleTitle1", + "url": "SampleUrl1" + }, + { + "title": "SampleTilte2", + "url": "SampleUrl2" + } + ], + "scope": "SampleScope", + "additionalInformation": [ + { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true + } + ], + "createdDate": "2018-04-10T03:12:23.4408944Z", + "resolvedDate": "2018-04-10T03:12:23.4408944Z", + "lastUpdated": "2018-04-30T19:24:42.1946017Z", + "monitorRoleType": "SampleRole", + "activeAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "resolvedAlertProperties": [ + { + "key": "ResolvedProperty1", + "value": "Value1" + } + ], + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json index 9fef3b89e159..b03ef23f477d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/BadPasswordDetails.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "userId": "SampleUser1", - "ipAddress": "SampleIPAddress", - "lastUpdated": "2018-04-25T14:39:18.3555285Z", - "uniqueIpAddresses": "SampleUniqueIPAddresses", - "totalErrorAttempts": 10 - } - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "userId": "SampleUser1", + "ipAddress": "SampleIPAddress", + "lastUpdated": "2018-04-25T14:39:18.3555285Z", + "uniqueIpAddresses": "SampleUniqueIPAddresses", + "totalErrorAttempts": 10 + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json index 0ce1a40c049c..bd92dec861d7 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/CheckFeatureAvailibility.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "featureName": "SampleFeatureName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": true - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json index 4ee3d644e30c..9eb84b0b864f 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Connectors.json @@ -1,105 +1,105 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "SampleId", - "name": "SampleName", - "version": 12418, - "type": "SampleType", - "description": "SampleDescription", - "schemaXml": "SampleSchema", - "passwordManagementSettings": { - "enabled": true, - "extensionFilePath": "SampleFilePath", - "connectTo": "SampleConnectTo", - "connectionTimeout": 24, - "user": "SampleUser", - "supportedPasswordOperations": "Undefined", - "maximumRetryCount": 10, - "retryIntervalInSeconds": 20, - "requiresSecureConnection": true, - "unlockAccount": true - }, - "passwordHashSyncConfiguration": { - "enabled": true, - "target": "SampleTarget" - }, - "timeCreated": "2017-08-04T19:07:02.957Z", - "timeLastModified": "2018-05-03T23:08:25.273Z", - "partitions": [ - { - "id": "SampleId", - "dn": "SampleDN", - "enabled": false, - "timeCreated": "2017-08-04T19:07:34.903Z", - "timeLastModified": "2018-05-03T23:08:25.273+00:00", - "partitionScope": { - "isDefault": false, - "objectClasses": [ - "SampleClass" - ], - "containersIncluded": [ - "SampleContainer" - ], - "containersExcluded": [ - "SampleContainer1" - ] - }, - "name": "SampleName", - "isDomain": true, - "type": "AD" - }, - { - "id": "SampleId2", - "dn": "SampleDN", - "enabled": true, - "timeCreated": "2017-08-04T19:07:34.97Z", - "timeLastModified": "2018-05-03T23:08:25.273+00:00", - "partitionScope": { - "isDefault": false, - "objectClasses": [ - "sampleClass" - ], - "containersIncluded": [ - "SampleContainer" - ], - "containersExcluded": [ - "SampleContainer1" - ] - }, - "name": "SampleName", - "isDomain": true, - "type": "AD" - } - ], - "runProfiles": [ - { - "id": "SampleId", - "name": "Full Import", - "runSteps": [ - { - "batchSize": 50, - "objectProcessLimit": 0, - "objectDeleteLimit": 0, - "pageSize": 500, - "partitionId": "SamplePartitionId", - "operationType": 1, - "timeout": 120 - } - ] - } - ], - "connectorId": "SampleConnectorId" - } - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SampleId", + "name": "SampleName", + "version": 12418, + "type": "SampleType", + "description": "SampleDescription", + "schemaXml": "SampleSchema", + "passwordManagementSettings": { + "enabled": true, + "extensionFilePath": "SampleFilePath", + "connectTo": "SampleConnectTo", + "connectionTimeout": 24, + "user": "SampleUser", + "supportedPasswordOperations": "Undefined", + "maximumRetryCount": 10, + "retryIntervalInSeconds": 20, + "requiresSecureConnection": true, + "unlockAccount": true + }, + "passwordHashSyncConfiguration": { + "enabled": true, + "target": "SampleTarget" + }, + "timeCreated": "2017-08-04T19:07:02.957Z", + "timeLastModified": "2018-05-03T23:08:25.273Z", + "partitions": [ + { + "id": "SampleId", + "dn": "SampleDN", + "enabled": false, + "timeCreated": "2017-08-04T19:07:34.903Z", + "timeLastModified": "2018-05-03T23:08:25.273+00:00", + "partitionScope": { + "isDefault": false, + "objectClasses": [ + "SampleClass" + ], + "containersIncluded": [ + "SampleContainer" + ], + "containersExcluded": [ + "SampleContainer1" + ] + }, + "name": "SampleName", + "isDomain": true, + "type": "AD" + }, + { + "id": "SampleId2", + "dn": "SampleDN", + "enabled": true, + "timeCreated": "2017-08-04T19:07:34.97Z", + "timeLastModified": "2018-05-03T23:08:25.273+00:00", + "partitionScope": { + "isDefault": false, + "objectClasses": [ + "sampleClass" + ], + "containersIncluded": [ + "SampleContainer" + ], + "containersExcluded": [ + "SampleContainer1" + ] + }, + "name": "SampleName", + "isDomain": true, + "type": "AD" + } + ], + "runProfiles": [ + { + "id": "SampleId", + "name": "Full Import", + "runSteps": [ + { + "batchSize": 50, + "objectProcessLimit": 0, + "objectDeleteLimit": 0, + "pageSize": 500, + "partitionId": "SamplePartitionId", + "operationType": 1, + "timeout": 120 + } + ] + } + ], + "connectorId": "SampleConnectorId" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json index 1c6ba5ad14f4..91739ff4be37 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Credentials.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "credentialData": [ - "SampleCredentialData", - "SampleCredentialData1" - ], - "identifier": "SampleIdentifier", - "type": "SampleType" - } - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "credentialData": [ + "SampleCredentialData", + "SampleCredentialData1" + ], + "identifier": "SampleIdentifier", + "type": "SampleType" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json index 1ad2374a08ba..9a8fd64f06ec 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Datafreshness.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "key": "DataFreshnessKeyName", - "value": "2015-03-06T17:41:34.305Z" - } - ] - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "DataFreshnessKeyName", + "value": "2015-03-06T17:41:34.305Z" + } + ] + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json index bbb11ed8bc78..4084aa42adfb 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteServer.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "serviceName": "SampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json index f5e15734edb6..9f1d47f9a401 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteService.json @@ -1,9 +1,9 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "204": {} - } -} +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json index cea5b2d2a2bc..5f36f434dc7d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DeleteUserPreference.json @@ -1,10 +1,10 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "featureName": "SampleFeatureName", - "api-version": "2014-01-01" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json index 1e16d8dd32e7..b0ae6c25772b 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/DevOps.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": true - } - } - } +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json index 5cea123a3b1d..77ccab084170 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Dimensions.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "dimension": "SmapleDimension", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "displayName": "sampleDisplayName", - "signature": "sampleSignature", - "type": "addsdomain", - "health": "Healthy", - "activeAlerts": 0, - "resolvedAlerts": 0, - "lastUpdated": "2018-04-09T23:55:51.0067357Z", - "simpleProperties": [ - { - "key": "Domain Functional Level", - "value": "Value1" - }, - { - "key": "Forest", - "value": "Value1" - }, - { - "key": "Infrastructure Master", - "value": "Value1" - }, - { - "key": "PDC", - "value": "Value1" - }, - { - "key": "RID Master", - "value": "Value1" - } - ], - "additionalInformation": "AdditionInformation1" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "dimension": "SmapleDimension", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "displayName": "sampleDisplayName", + "signature": "sampleSignature", + "type": "addsdomain", + "health": "Healthy", + "activeAlerts": 0, + "resolvedAlerts": 0, + "lastUpdated": "2018-04-09T23:55:51.0067357Z", + "simpleProperties": [ + { + "key": "Domain Functional Level", + "value": "Value1" + }, + { + "key": "Forest", + "value": "Value1" + }, + { + "key": "Infrastructure Master", + "value": "Value1" + }, + { + "key": "PDC", + "value": "Value1" + }, + { + "key": "RID Master", + "value": "Value1" + } + ], + "additionalInformation": "AdditionInformation1" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json index 47ce1fdb5b5a..b07c1ac91ce3 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ErrorCounts.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "errorBucket": "DuplicateAttributeError", - "count": 49, - "truncated": false - }, - { - "errorBucket": "DataMismatch", - "count": 0, - "truncated": false - }, - { - "errorBucket": "DataValidationError", - "count": 0, - "truncated": false - }, - { - "errorBucket": "LargeAttribute", - "count": 0, - "truncated": false - }, - { - "errorBucket": "FederatedDomainChange", - "count": 0, - "truncated": false - }, - { - "errorBucket": "Others", - "count": 0, - "truncated": false - }, - { - "errorBucket": "All", - "count": 49, - "truncated": false - } - ] - } - } - } +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "errorBucket": "DuplicateAttributeError", + "count": 49, + "truncated": false + }, + { + "errorBucket": "DataMismatch", + "count": 0, + "truncated": false + }, + { + "errorBucket": "DataValidationError", + "count": 0, + "truncated": false + }, + { + "errorBucket": "LargeAttribute", + "count": 0, + "truncated": false + }, + { + "errorBucket": "FederatedDomainChange", + "count": 0, + "truncated": false + }, + { + "errorBucket": "Others", + "count": 0, + "truncated": false + }, + { + "errorBucket": "All", + "count": 49, + "truncated": false + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json index 61442ed7c22b..96feb49289ad 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportErrors.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "runstepresultid": "SampleRunStepResultId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "errorbucket": "SampleErrorBucket", - "count": 10, - "truncated": true - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "runstepresultid": "SampleRunStepResultId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "errorbucket": "SampleErrorBucket", + "count": 10, + "truncated": true + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json index 8cfaec524971..0803375d4f30 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ExportStatus.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "serviceId": "sampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "endTime": "2018-04-30T23:04:37.647Z", - "runStepResultId": "SampleRunStepId" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "serviceId": "sampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "endTime": "2018-04-30T23:04:37.647Z", + "runStepResultId": "SampleRunStepId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json index 6249725dabe0..292118035860 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ForestSummary.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "forestName": "sampleForestName", - "domainCount": 1, - "siteCount": 1, - "monitoredDcCount": 1, - "totalDcCount": 1, - "domains": [ - "sampledomain" - ], - "sites": [ - "Default-First-Site-Name" - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "forestName": "sampleForestName", + "domainCount": 1, + "siteCount": 1, + "monitoredDcCount": 1, + "totalDcCount": 1, + "domains": [ + "sampledomain" + ], + "sites": [ + "Default-First-Site-Name" + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json index 3daf3db02e56..f253e881a876 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GetAlertFeedback.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "shortName": "AlertShortName" , - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "level": "Error", - "state": "Active", - "createdDate": "2018-04-30T23:28:19.6001893Z", - "shortName": "AlertShortName", - "feedback": "Like", - "comment": "SampleComment", - "consentedToShare": false, - "serviceMemberId": null - } - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "shortName": "AlertShortName" , + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "level": "Error", + "state": "Active", + "createdDate": "2018-04-30T23:28:19.6001893Z", + "shortName": "AlertShortName", + "feedback": "Like", + "comment": "SampleComment", + "consentedToShare": false, + "serviceMemberId": null + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json index 0638dea4eb87..92e68cc6031b 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/GlobalConfiguration.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "featureSet": [ - { - "key": "faturekey1", - "value": "value1" - } - ], - "numSavedPwdEvent": 0, - "passwordSyncEnabled": false, - "schemaXml": "SampleSchemaXML", - "version": 12 - } - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "featureSet": [ + { + "key": "faturekey1", + "value": "value1" + } + ], + "numSavedPwdEvent": 0, + "passwordSyncEnabled": false, + "schemaXml": "SampleSchemaXML", + "version": 12 + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json index ede4242bd447..7a763745c2c5 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MergedExportErrors.json @@ -1,66 +1,66 @@ -{ - "parameters": { - "serviceName": "SampleName", - "errorBucket": "SampleErrorBucket", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "incomingObjectDisplayName": "SampleIncomingDisplayName", - "incomingObjectType": "user", - "userPrincipalName": "SampleUPN", - "type": "AttributeValueMustBeUnique", - "attributeName": "OnPremiseSecurityIdentifier", - "attributeValue": "System.Byte[]", - "timeOccurred": "2018-04-30T22:04:36.043Z", - "timeFirstOccurred": "2017-07-11T18:36:15.843Z", - "csObjectId": "SampleObjectId", - "dn": "CN=SampleDN", - "incomingObject": { - "displayName": "SampleDisplayName", - "distinguishedName": "SampelDN", - "lastDirSyncTime": "2016-06-02T18:41:59Z", - "mail": "SampleMail", - "objectGuid": "SampleObjectGuid", - "objectType": "user", - "onpremisesUserPrincipalName": "SampleUPN1", - "proxyAddresses": "SampleProxyAddress", - "sourceAnchor": "SampleSourceAnchor", - "sourceOfAuthority": "Unknown", - "timeOccurred": "2018-04-30T22:04:36.043Z", - "userPrincipalName": "SampleUPN" - }, - "existingObject": { - "displayName": "SampleDisplayName", - "distinguishedName": "SampleDistinguishedName", - "lastDirSyncTime": "2016-06-02T18:41:59Z", - "mail": "SampleEmail", - "objectGuid": "SampleObjectGuid", - "objectType": "User", - "onpremisesUserPrincipalName": "OnPremUPN", - "proxyAddresses": "SampleProxyAddress", - "sourceAnchor": "SampleSourceAnchor", - "sourceOfAuthority": "Active Directory", - "timeOccurred": "0001-01-01T00:00:00Z", - "userPrincipalName": "SampleUPN" - }, - "modifiedOrRemovedAttributeValue": "SampleValue", - "runStepResultId": "SampleRunStepId", - "samAccountName": "SampleSAMAccountName", - "serverErrorDetail": "SampleErrorDetails", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "id": "SampleMergedExportErrorId", - "mergedEntityId": "SampleMergedEntityId", - "createdDate": "2018-04-30T22:13:47.6380995Z", - "exportErrorStatus": 1 - } - ] - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "errorBucket": "SampleErrorBucket", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "incomingObjectDisplayName": "SampleIncomingDisplayName", + "incomingObjectType": "user", + "userPrincipalName": "SampleUPN", + "type": "AttributeValueMustBeUnique", + "attributeName": "OnPremiseSecurityIdentifier", + "attributeValue": "System.Byte[]", + "timeOccurred": "2018-04-30T22:04:36.043Z", + "timeFirstOccurred": "2017-07-11T18:36:15.843Z", + "csObjectId": "SampleObjectId", + "dn": "CN=SampleDN", + "incomingObject": { + "displayName": "SampleDisplayName", + "distinguishedName": "SampelDN", + "lastDirSyncTime": "2016-06-02T18:41:59Z", + "mail": "SampleMail", + "objectGuid": "SampleObjectGuid", + "objectType": "user", + "onpremisesUserPrincipalName": "SampleUPN1", + "proxyAddresses": "SampleProxyAddress", + "sourceAnchor": "SampleSourceAnchor", + "sourceOfAuthority": "Unknown", + "timeOccurred": "2018-04-30T22:04:36.043Z", + "userPrincipalName": "SampleUPN" + }, + "existingObject": { + "displayName": "SampleDisplayName", + "distinguishedName": "SampleDistinguishedName", + "lastDirSyncTime": "2016-06-02T18:41:59Z", + "mail": "SampleEmail", + "objectGuid": "SampleObjectGuid", + "objectType": "User", + "onpremisesUserPrincipalName": "OnPremUPN", + "proxyAddresses": "SampleProxyAddress", + "sourceAnchor": "SampleSourceAnchor", + "sourceOfAuthority": "Active Directory", + "timeOccurred": "0001-01-01T00:00:00Z", + "userPrincipalName": "SampleUPN" + }, + "modifiedOrRemovedAttributeValue": "SampleValue", + "runStepResultId": "SampleRunStepId", + "samAccountName": "SampleSAMAccountName", + "serverErrorDetail": "SampleErrorDetails", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "id": "SampleMergedExportErrorId", + "mergedEntityId": "SampleMergedEntityId", + "createdDate": "2018-04-30T22:13:47.6380995Z", + "exportErrorStatus": 1 + } + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json index e061ed80aac4..de6d68766547 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadata.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "serviceName": "SampleName", - "metricName": "SampleMetricName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "metricsProcessorClassName": "SampleMetricsProcessorClassName1", - "metricName": "SampleMetricName", - "groupings": [ - { - "key": "SampleKey", - "displayName": "SampleDisplayName", - "invisibleForUi": false - } - ], - "displayName": "SampleDisplayName", - "valueKind": "Value", - "minValue": 0, - "maxValue": 0, - "kind": "Line", - "isDefault": false, - "isPerfCounter": false, - "isDevOps": false - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "metricName": "SampleMetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "metricsProcessorClassName": "SampleMetricsProcessorClassName1", + "metricName": "SampleMetricName", + "groupings": [ + { + "key": "SampleKey", + "displayName": "SampleDisplayName", + "invisibleForUi": false + } + ], + "displayName": "SampleDisplayName", + "valueKind": "Value", + "minValue": 0, + "maxValue": 0, + "kind": "Line", + "isDefault": false, + "isPerfCounter": false, + "isDevOps": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json index 6cf99c1fc013..e91c9ec0b1c3 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricMetadataList.json @@ -1,37 +1,37 @@ -{ - "parameters": { - "serviceName": "SampleName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "metricsProcessorClassName": "SampleMetricsProcessorClassName1", - "metricName": "SampleMetricName", - "groupings": [ - { - "key": "SampleKey", - "displayName": "SampleDisplayName", - "invisibleForUi": false - } - ], - "displayName": "SampleDisplayName", - "valueKind": "Value", - "minValue": 0, - "maxValue": 0, - "kind": "Line", - "isDefault": false, - "isPerfCounter": false, - "isDevOps": false - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricsProcessorClassName": "SampleMetricsProcessorClassName1", + "metricName": "SampleMetricName", + "groupings": [ + { + "key": "SampleKey", + "displayName": "SampleDisplayName", + "invisibleForUi": false + } + ], + "displayName": "SampleDisplayName", + "valueKind": "Value", + "minValue": 0, + "maxValue": 0, + "kind": "Line", + "isDefault": false, + "isPerfCounter": false, + "isDevOps": false + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json index c253c6f6adf6..61afc1e724e8 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MetricSets.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "serviceName": "SampleName", - "groupName": "SampleGroupName", - "metricName": "SamplemetricName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "sets": [ - { - "setName": "SampleSetName", - "values": [ - null, - null, - null, - null, - null, - null, - null, - null, - null, - null, - 5.0, - 8.0, - 3.0, - 3.0, - 12.0, - 7.0, - 7.0, - 10.0, - null, - 1.0, - 1.0, - 2.0, - 2.0, - null - ] - } - ], - "timeStamps": [ - "2018-04-29T22:00:00Z", - "2018-04-29T23:00:00Z", - "2018-04-30T00:00:00Z", - "2018-04-30T01:00:00Z", - "2018-04-30T02:00:00Z", - "2018-04-30T03:00:00Z", - "2018-04-30T04:00:00Z", - "2018-04-30T05:00:00Z", - "2018-04-30T06:00:00Z", - "2018-04-30T07:00:00Z", - "2018-04-30T08:00:00Z", - "2018-04-30T09:00:00Z", - "2018-04-30T10:00:00Z", - "2018-04-30T11:00:00Z", - "2018-04-30T12:00:00Z", - "2018-04-30T13:00:00Z", - "2018-04-30T14:00:00Z", - "2018-04-30T15:00:00Z", - "2018-04-30T16:00:00Z", - "2018-04-30T17:00:00Z", - "2018-04-30T18:00:00Z", - "2018-04-30T19:00:00Z", - "2018-04-30T20:00:00Z", - "2018-04-30T21:00:00Z" - ] - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json index 0a9d5653b524..a77e5532004f 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Metrics.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "serviceName": "SampleName", - "metricName": "SampleMetricName", - "groupName": "SampleGroupName", - "metricsName": "SampleMetricName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "key": "Key1", - "value": "Value1" - }, - { - "key": "Key2", - "value": "Value2" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } - } - +{ + "parameters": { + "serviceName": "SampleName", + "metricName": "SampleMetricName", + "groupName": "SampleGroupName", + "metricsName": "SampleMetricName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "Key1", + "value": "Value1" + }, + { + "key": "Key2", + "value": "Value2" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } + } + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json index ad283c422a0d..4d17304f4b96 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/MonitoringConfigurations.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "key": "MonitoringLevel", - "value": "Partial" - }, - { - "key": "StagingMode", - "value": "" - }, - { - "key": "ConfigurationUploadInterval", - "value": "240" - } - ] - } - } - } +{ + "parameters": { + "serviceName": "SampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "MonitoringLevel", + "value": "Partial" + }, + { + "key": "StagingMode", + "value": "" + }, + { + "key": "ConfigurationUploadInterval", + "value": "240" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json index 4dbc1b4eecf7..06f4a923ba24 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/OperationList.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.ADHybridHealthService_Sample_Operation", - "display": { - "description": "Sample description", - "operation": "Sample operation", - "provider": "Microsoft ADHybridHealthService", - "resource": "Sample Resource" - } - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ADHybridHealthService_Sample_Operation", + "display": { + "description": "Sample description", + "operation": "Sample operation", + "provider": "Microsoft ADHybridHealthService", + "resource": "Sample Resource" + } + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json index 733e515c3fad..1f1ac0e84c0a 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchMonitoringConfiguration.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "serviceName": "SampleServiceName", - "configurationSetting": { - "key": "key1", - "value": "Value1" - }, - "api-version": "2014-01-01" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "serviceName": "SampleServiceName", + "configurationSetting": { + "key": "key1", + "value": "Value1" + }, + "api-version": "2014-01-01" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json index 371ade172f52..2a387e9a6e8a 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/PatchTenant.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "tenant": [ - { - "agentAutoUpdate": false - } - ], - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "tenantId": "sampleTenantId", - "tenantName": "SampleTenantName", - "initialDomain": "tenantInitialDomain", - "devOpsTtl": "0001-01-01T00:00:00Z", - "countryLetterCode": "tenantCountryLetterCode", - "createdDate": "2015-03-06T20:35:04.0018068Z", - "pksCertificate": "SamplePKSCertificate", - "disabled": false, - "lastDisabled": "0001-01-01T00:00:00Z", - "lastVerified": "0001-01-01T00:00:00Z", - "aadLicense": "Premium", - "onboardingAllowed": true, - "onboarded": true, - "privatePreviewTenant": false, - "consentedToMicrosoftDevOps": true, - "alertSuppressionTimeInMins": 4320, - "aadPremium": true, - "globalAdminsEmail": [ - "email1", - "email2" - ], - "agentAutoUpdate": true, - "disabledReason": 0, - "tenantInQuarantine": false - } - } - } -} - +{ + "parameters": { + "tenant": [ + { + "agentAutoUpdate": false + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json index 36568b3b4bc3..d28151b8ae3d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationDetails.json @@ -1,44 +1,44 @@ -{ - "parameters": { - "serviceName": "SampleName", - "query": "SampleQuery", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "targetServer": "SampleTargetServerName", - "site": "Domain-Controllers", - "domain": "SampleDomainName", - "status": 0, - "lastAttemptedSync": "2018-04-30T21:40:10Z", - "lastSuccessfulSync": "2018-04-30T21:40:10Z", - "inboundNeighborCollection": [ - { - "sourceDomainController": "SampleSourceDomainName", - "consecutiveFailureCount": 0, - "namingContext": "SampleNamingContext", - "status": 0, - "lastAttemptedSync": "2018-04-30T21:39:45+00:00", - "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", - "lastErrorCode": 0, - "lastErrorMessage": "The operation completed successfully.\r\n", - "errorTitle": "SampleErrorTitle", - "errorDescription": "SampleErrorDescription", - "fixLink": "SampleFixLink", - "fixDetails": "SampleFixDescription", - "additionalInfo": "SampleAdditionalInformation" - } - ] - } - ], - "nextLink": null, - "totalCount": 1, - "continuationToken": null - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "query": "SampleQuery", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "targetServer": "SampleTargetServerName", + "site": "Domain-Controllers", + "domain": "SampleDomainName", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:40:10Z", + "lastSuccessfulSync": "2018-04-30T21:40:10Z", + "inboundNeighborCollection": [ + { + "sourceDomainController": "SampleSourceDomainName", + "consecutiveFailureCount": 0, + "namingContext": "SampleNamingContext", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:39:45+00:00", + "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", + "lastErrorCode": 0, + "lastErrorMessage": "The operation completed successfully.\r\n", + "errorTitle": "SampleErrorTitle", + "errorDescription": "SampleErrorDescription", + "fixLink": "SampleFixLink", + "fixDetails": "SampleFixDescription", + "additionalInfo": "SampleAdditionalInformation" + } + ] + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json index 51c8c2bb3665..54e373e85a3f 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationStatus.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "serviceName": "SampleName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "forestName": "SampleForestName", - "totalDcCount": 6, - "errorDcCount": 0 - } - } - } - } - +{ + "parameters": { + "serviceName": "SampleName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "forestName": "SampleForestName", + "totalDcCount": 6, + "errorDcCount": 0 + } + } + } + } + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json index d82d6bb2c00c..1b2f7cccd6a1 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ReplicationSummary.json @@ -1,44 +1,44 @@ -{ - "parameters": { - "serviceName": "SampleName", - "isGroupbySite": true, - "query": "SampleQuery", - "nextPartitionKey": " ", - "nextRowKey":" ", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "targetServer": "SampleTargetServerName", - "site": "Domain-Controllers", - "domain": "SampleDomainName", - "status": 0, - "lastAttemptedSync": "2018-04-30T21:40:10Z", - "lastSuccessfulSync": "2018-04-30T21:40:10Z", - "inboundNeighborCollection": [ - { - "sourceDomainController": "SampleSourceDomainName", - "consecutiveFailureCount": 0, - "namingContext": "SampleNamingContext", - "status": 0, - "lastAttemptedSync": "2018-04-30T21:39:45+00:00", - "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", - "lastErrorCode": 0, - "lastErrorMessage": "The operation completed successfully.\r\n", - "errorTitle": "SampleErrorTitle", - "errorDescription": "SampleErrorDescription", - "fixLink": "SampleFixLink", - "fixDetails": "SampleFixDescription", - "additionalInfo": "SampleAdditionalInformation" - } - ] - } - ] - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "isGroupbySite": true, + "query": "SampleQuery", + "nextPartitionKey": " ", + "nextRowKey":" ", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "targetServer": "SampleTargetServerName", + "site": "Domain-Controllers", + "domain": "SampleDomainName", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:40:10Z", + "lastSuccessfulSync": "2018-04-30T21:40:10Z", + "inboundNeighborCollection": [ + { + "sourceDomainController": "SampleSourceDomainName", + "consecutiveFailureCount": 0, + "namingContext": "SampleNamingContext", + "status": 0, + "lastAttemptedSync": "2018-04-30T21:39:45+00:00", + "lastSuccessfulSync": "2018-04-30T21:39:45+00:00", + "lastErrorCode": 0, + "lastErrorMessage": "The operation completed successfully.\r\n", + "errorTitle": "SampleErrorTitle", + "errorDescription": "SampleErrorDescription", + "fixLink": "SampleFixLink", + "fixDetails": "SampleFixDescription", + "additionalInfo": "SampleAdditionalInformation" + } + ] + } + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json index a2836858b7bb..e5efeb79f677 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json @@ -1,75 +1,75 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "state": "Active", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "alertId": "SampleAlertId", - "level": "Error", - "state": "Active", - "shortName": "SampleAlertName", - "displayName": "SampleAlertDisplayName", - "description": "SampleAlertDescription", - "remediation": "SampleAlertRemediation", - "relatedLinks": [ - { - "title": "SampleTitle1", - "url": "SampleUrl1" - }, - { - "title": "SampleTilte2", - "url": "SampleUrl2" - } - ], - "scope": "SampleScope", - "additionalInformation": [ - { - "titleName": "SampleAdditionalInfo", - "titleValue": "SampleTitle", - "properties": [ - { - "key": "Property1", - "value": "Value1" - }, - { - "key": "Property2", - "value": "Value2" - } - ], - "hasProperties": true - } - ], - "createdDate": "2018-04-10T03:12:23.4408944Z", - "resolvedDate": "2018-04-10T03:12:23.4408944Z", - "lastUpdated": "2018-04-30T19:24:42.1945017Z", - "monitorRoleType": "SampleRole", - "activeAlertProperties": [ - { - "key": "ActiveProperty1", - "value": "Value1" - } - ], - "resolvedAlertProperties": [ - { - "key": "ActiveProperty1", - "value": "Value1" - } - ], - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "state": "Active", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "alertId": "SampleAlertId", + "level": "Error", + "state": "Active", + "shortName": "SampleAlertName", + "displayName": "SampleAlertDisplayName", + "description": "SampleAlertDescription", + "remediation": "SampleAlertRemediation", + "relatedLinks": [ + { + "title": "SampleTitle1", + "url": "SampleUrl1" + }, + { + "title": "SampleTilte2", + "url": "SampleUrl2" + } + ], + "scope": "SampleScope", + "additionalInformation": [ + { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true + } + ], + "createdDate": "2018-04-10T03:12:23.4408944Z", + "resolvedDate": "2018-04-10T03:12:23.4408944Z", + "lastUpdated": "2018-04-30T19:24:42.1945017Z", + "monitorRoleType": "SampleRole", + "activeAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "resolvedAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json index 3cbfd9b38dcf..6f9fc5b04d8a 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_ExportStatus.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "serviceId": "sampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "endTime": "2018-04-30T23:04:37.647Z", - "runStepResultId": "SampleRunStepId" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "serviceId": "sampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "endTime": "2018-04-30T23:04:37.647Z", + "runStepResultId": "SampleRunStepId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json index 75cff508869c..aac735d8184f 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_MetricSets.json @@ -1,73 +1,73 @@ -{ - "parameters": { - "serviceName": "SampleName", - "groupName": "SampleGroupName", - "metricName": "SamplemetricName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "sets": [ - { - "setName": "SampleSetName", - "values": [ - null, - null, - null, - null, - null, - null, - null, - null, - null, - null, - 5.0, - 8.0, - 3.0, - 3.0, - 12.0, - 7.0, - 7.0, - 10.0, - null, - 1.0, - 1.0, - 2.0, - 2.0, - null - ] - } - ], - "timeStamps": [ - "2018-04-29T22:00:00Z", - "2018-04-29T23:00:00Z", - "2018-04-30T00:00:00Z", - "2018-04-30T01:00:00Z", - "2018-04-30T02:00:00Z", - "2018-04-30T03:00:00Z", - "2018-04-30T04:00:00Z", - "2018-04-30T05:00:00Z", - "2018-04-30T06:00:00Z", - "2018-04-30T07:00:00Z", - "2018-04-30T08:00:00Z", - "2018-04-30T09:00:00Z", - "2018-04-30T10:00:00Z", - "2018-04-30T11:00:00Z", - "2018-04-30T12:00:00Z", - "2018-04-30T13:00:00Z", - "2018-04-30T14:00:00Z", - "2018-04-30T15:00:00Z", - "2018-04-30T16:00:00Z", - "2018-04-30T17:00:00Z", - "2018-04-30T18:00:00Z", - "2018-04-30T19:00:00Z", - "2018-04-30T20:00:00Z", - "2018-04-30T21:00:00Z" - ] - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json index 1204d27e1ff5..80a3ede9ef60 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "activeAlerts": 0, - "additionalInformation": "SampleAdditionalInformation", - "createdDate": "2017-04-07T16:03:06.9053139Z", - "customNotificationEmails": [ - "email1", - "email2" - ], - "disabled": false, - "displayName": "sample display name", - "health": "Healthy", - "lastDisabled": "2017-05-07T16:03:06.9053139Z", - "lastUpdated": "2018-04-30T00:55:33.5799677Z", - "monitoringConfigurationsComputed": "samplemonitoringConfig", - "monitoringConfigurationsCustomized": "samplemonitoringConfig", - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalAdmins": true, - "notificationEmails": [ - "email3", - "email4" - ], - "notificationEmailsEnabledForGlobalAdmins": false, - "resolvedAlerts": 0, - "serviceId": "12345678-1234-1234-1234-123456789000", - "serviceName": "sampleServiceName", - "signature": "SampleSignature", - "simpleProperties": null, - "tenantId": "12345678-1234-1234-1234-123456789000", - "type": "AadSyncService", - "originalDisabledState": false, - "id": "ServiceId" - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "ServiceId" + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json index 2f24f3d25b5a..74a798386084 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceConfiguration.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "version": "1.1.750.0", - "serviceType": 1, - "serviceAccount": "SampleServiceAccount", - "sqlServer": "SQLServerName", - "sqlVersion": "unknown", - "sqlEdition": "unknown", - "sqlInstance": "", - "sqlDatabaseName": "SQLDBName", - "sqlDatabaseSize": 0 - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "version": "1.1.750.0", + "serviceType": 1, + "serviceAccount": "SampleServiceAccount", + "sqlServer": "SQLServerName", + "sqlVersion": "unknown", + "sqlEdition": "unknown", + "sqlInstance": "", + "sqlDatabaseName": "SQLDBName", + "sqlDatabaseSize": 0 + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json index e9400c120928..85606507c8e7 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMember.json @@ -1,67 +1,67 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "lastReboot": "2018-04-28T11:33:07.484Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-05-01T00:15:32.5476494Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T11:33:07.484Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "machineId": "SampleMachineId", - "machineName": "SampleMachineName", - "role": "AdfsServer_30", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "SampleOSVersion", - "osName": "SampleOSName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "SampleOSVersion", + "osName": "SampleOSName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json index c5f1b176845f..fdff90c3dee5 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/ServiceMembers.json @@ -1,73 +1,73 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "lastReboot": "2018-04-28T11:33:07.484Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-05-01T00:15:32.5476494Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T11:33:07.484Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId", - "machineId": "SampleMachineId", - "machineName": "SampleMachineName", - "role": "AdfsServer_30", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "SampleOSVersion", - "osName": "SampleOSName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "serviceName": "sampleServiceName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "lastReboot": "2018-04-28T11:33:07.484Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-05-01T00:15:32.5476494Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T11:33:07.484Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId", + "machineId": "SampleMachineId", + "machineName": "SampleMachineName", + "role": "AdfsServer_30", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "SampleOSVersion", + "osName": "SampleOSName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json index 75cff508869c..aac735d8184f 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Service_MetricSets.json @@ -1,73 +1,73 @@ -{ - "parameters": { - "serviceName": "SampleName", - "groupName": "SampleGroupName", - "metricName": "SamplemetricName", - "serviceMemberId": "SampleServiceMemberId", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "sets": [ - { - "setName": "SampleSetName", - "values": [ - null, - null, - null, - null, - null, - null, - null, - null, - null, - null, - 5.0, - 8.0, - 3.0, - 3.0, - 12.0, - 7.0, - 7.0, - 10.0, - null, - 1.0, - 1.0, - 2.0, - 2.0, - null - ] - } - ], - "timeStamps": [ - "2018-04-29T22:00:00Z", - "2018-04-29T23:00:00Z", - "2018-04-30T00:00:00Z", - "2018-04-30T01:00:00Z", - "2018-04-30T02:00:00Z", - "2018-04-30T03:00:00Z", - "2018-04-30T04:00:00Z", - "2018-04-30T05:00:00Z", - "2018-04-30T06:00:00Z", - "2018-04-30T07:00:00Z", - "2018-04-30T08:00:00Z", - "2018-04-30T09:00:00Z", - "2018-04-30T10:00:00Z", - "2018-04-30T11:00:00Z", - "2018-04-30T12:00:00Z", - "2018-04-30T13:00:00Z", - "2018-04-30T14:00:00Z", - "2018-04-30T15:00:00Z", - "2018-04-30T16:00:00Z", - "2018-04-30T17:00:00Z", - "2018-04-30T18:00:00Z", - "2018-04-30T19:00:00Z", - "2018-04-30T20:00:00Z", - "2018-04-30T21:00:00Z" - ] - } - } - } -} - +{ + "parameters": { + "serviceName": "SampleName", + "groupName": "SampleGroupName", + "metricName": "SamplemetricName", + "serviceMemberId": "SampleServiceMemberId", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "sets": [ + { + "setName": "SampleSetName", + "values": [ + null, + null, + null, + null, + null, + null, + null, + null, + null, + null, + 5.0, + 8.0, + 3.0, + 3.0, + 12.0, + 7.0, + 7.0, + 10.0, + null, + 1.0, + 1.0, + 2.0, + 2.0, + null + ] + } + ], + "timeStamps": [ + "2018-04-29T22:00:00Z", + "2018-04-29T23:00:00Z", + "2018-04-30T00:00:00Z", + "2018-04-30T01:00:00Z", + "2018-04-30T02:00:00Z", + "2018-04-30T03:00:00Z", + "2018-04-30T04:00:00Z", + "2018-04-30T05:00:00Z", + "2018-04-30T06:00:00Z", + "2018-04-30T07:00:00Z", + "2018-04-30T08:00:00Z", + "2018-04-30T09:00:00Z", + "2018-04-30T10:00:00Z", + "2018-04-30T11:00:00Z", + "2018-04-30T12:00:00Z", + "2018-04-30T13:00:00Z", + "2018-04-30T14:00:00Z", + "2018-04-30T15:00:00Z", + "2018-04-30T16:00:00Z", + "2018-04-30T17:00:00Z", + "2018-04-30T18:00:00Z", + "2018-04-30T19:00:00Z", + "2018-04-30T20:00:00Z", + "2018-04-30T21:00:00Z" + ] + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json index ba2b4e9e83aa..d403f0e3a5a2 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Services.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "activeAlerts": 0, - "additionalInformation": "SampleAdditionalInformation", - "createdDate": "2017-04-07T16:03:06.9053139Z", - "customNotificationEmails": [ - "email1", - "email2" - ], - "disabled": false, - "displayName": "sample display name", - "health": "Healthy", - "lastDisabled": "2017-05-07T16:03:06.9053139Z", - "lastUpdated": "2018-04-30T00:55:33.5799677Z", - "monitoringConfigurationsComputed": "samplemonitoringConfig", - "monitoringConfigurationsCustomized": "samplemonitoringConfig", - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalAdmins": true, - "notificationEmails": [ - "email3", - "email4" - ], - "notificationEmailsEnabledForGlobalAdmins": false, - "resolvedAlerts": 0, - "serviceId": "12345678-1234-1234-1234-123456789000", - "serviceName": "sampleServiceName", - "signature": "SampleSignature", - "simpleProperties": null, - "tenantId": "12345678-1234-1234-1234-123456789000", - "type": "AadSyncService", - "originalDisabledState": false, - "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck" - } - ], - "nextLink": null, - "totalCount": 1, - "continuationToken": null - } - } - } -} +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck" + } + ], + "nextLink": null, + "totalCount": 1, + "continuationToken": null + } + } + } +} diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json index 04c2d1147186..4c4394feaf93 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Tenant.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "tenantId": "sampleTenantId", - "tenantName": "SampleTenantName", - "initialDomain": "tenantInitialDomain", - "devOpsTtl": "0001-01-01T00:00:00Z", - "countryLetterCode": "tenantCountryLetterCode", - "createdDate": "2015-03-06T20:35:04.0018068Z", - "pksCertificate": "SamplePKSCertificate", - "disabled": false, - "lastDisabled": "0001-01-01T00:00:00Z", - "lastVerified": "0001-01-01T00:00:00Z", - "aadLicense": "Premium", - "onboardingAllowed": true, - "onboarded": true, - "privatePreviewTenant": false, - "consentedToMicrosoftDevOps": true, - "alertSuppressionTimeInMins": 4320, - "aadPremium": true, - "globalAdminsEmail": [ - "email1", - "email2" - ], - "agentAutoUpdate": true, - "disabledReason": 0, - "tenantInQuarantine": false - } - } - } -} - +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + } + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json index 0ce1a40c049c..bd92dec861d7 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/TenantWhitelisting.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "featureName": "SampleFeatureName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "value": true - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "value": true + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json index 5c74b064819b..3d7582a55015 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateService.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "service": [ - { - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalADmins": true - } - ], - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "activeAlerts": 0, - "additionalInformation": "SampleAdditionalInformation", - "createdDate": "2017-04-07T16:03:06.9053139Z", - "customNotificationEmails": [ - "email1", - "email2" - ], - "disabled": false, - "displayName": "sample display name", - "health": "Healthy", - "lastDisabled": "2017-05-07T16:03:06.9053139Z", - "lastUpdated": "2018-04-30T00:55:33.5799677Z", - "monitoringConfigurationsComputed": "samplemonitoringConfig", - "monitoringConfigurationsCustomized": "samplemonitoringConfig", - "notificationEmailEnabled": true, - "notificationEmailEnabledForGlobalAdmins": true, - "notificationEmails": [ - "email3", - "email4" - ], - "notificationEmailsEnabledForGlobalAdmins": false, - "resolvedAlerts": 0, - "serviceId": "12345678-1234-1234-1234-123456789000", - "serviceName": "sampleServiceName", - "signature": "SampleSignature", - "simpleProperties": null, - "tenantId": "12345678-1234-1234-1234-123456789000", - "type": "AadSyncService", - "originalDisabledState": false, - "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck/sampleServiceName" - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "service": [ + { + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalADmins": true + } + ], + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "activeAlerts": 0, + "additionalInformation": "SampleAdditionalInformation", + "createdDate": "2017-04-07T16:03:06.9053139Z", + "customNotificationEmails": [ + "email1", + "email2" + ], + "disabled": false, + "displayName": "sample display name", + "health": "Healthy", + "lastDisabled": "2017-05-07T16:03:06.9053139Z", + "lastUpdated": "2018-04-30T00:55:33.5799677Z", + "monitoringConfigurationsComputed": "samplemonitoringConfig", + "monitoringConfigurationsCustomized": "samplemonitoringConfig", + "notificationEmailEnabled": true, + "notificationEmailEnabledForGlobalAdmins": true, + "notificationEmails": [ + "email3", + "email4" + ], + "notificationEmailsEnabledForGlobalAdmins": false, + "resolvedAlerts": 0, + "serviceId": "12345678-1234-1234-1234-123456789000", + "serviceName": "sampleServiceName", + "signature": "SampleSignature", + "simpleProperties": null, + "tenantId": "12345678-1234-1234-1234-123456789000", + "type": "AadSyncService", + "originalDisabledState": false, + "id": "/providers/Microsoft.ADHybridHealthService/services/GetServices/PremiumCheck/sampleServiceName" + } + } + } } \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json index d662a3048e8c..124c850a85b3 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UpdateTenant.json @@ -1,37 +1,37 @@ -{ - "parameters": { - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "tenantId": "sampleTenantId", - "tenantName": "SampleTenantName", - "initialDomain": "tenantInitialDomain", - "devOpsTtl": "0001-01-01T00:00:00Z", - "countryLetterCode": "tenantCountryLetterCode", - "createdDate": "2015-03-06T20:35:04.0018068Z", - "pksCertificate": "SamplePKSCertificate", - "disabled": false, - "lastDisabled": "0001-01-01T00:00:00Z", - "lastVerified": "0001-01-01T00:00:00Z", - "aadLicense": "Premium", - "onboardingAllowed": true, - "onboarded": true, - "privatePreviewTenant": false, - "consentedToMicrosoftDevOps": true, - "alertSuppressionTimeInMins": 4320, - "aadPremium": true, - "globalAdminsEmail": [ - "email1", - "email2" - ], - "agentAutoUpdate": true, - "disabledReason": 0, - "tenantInQuarantine": false - } - }, - "404": {} - } -} - +{ + "parameters": { + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "tenantId": "sampleTenantId", + "tenantName": "SampleTenantName", + "initialDomain": "tenantInitialDomain", + "devOpsTtl": "0001-01-01T00:00:00Z", + "countryLetterCode": "tenantCountryLetterCode", + "createdDate": "2015-03-06T20:35:04.0018068Z", + "pksCertificate": "SamplePKSCertificate", + "disabled": false, + "lastDisabled": "0001-01-01T00:00:00Z", + "lastVerified": "0001-01-01T00:00:00Z", + "aadLicense": "Premium", + "onboardingAllowed": true, + "onboarded": true, + "privatePreviewTenant": false, + "consentedToMicrosoftDevOps": true, + "alertSuppressionTimeInMins": 4320, + "aadPremium": true, + "globalAdminsEmail": [ + "email1", + "email2" + ], + "agentAutoUpdate": true, + "disabledReason": 0, + "tenantInQuarantine": false + } + }, + "404": {} + } +} + diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json index b71769319512..88dfac08a310 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/UserPreference.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "serviceName": "sampleServiceName", - "featureName": "SampleFeatureName", - "api-version": "2014-01-01" - }, - "responses": { - "200": { - "body": { - "metricNames": [ - "UserPreference1", - "UserPreference2" - ] - } - } - } +{ + "parameters": { + "serviceName": "sampleServiceName", + "featureName": "SampleFeatureName", + "api-version": "2014-01-01" + }, + "responses": { + "200": { + "body": { + "metricNames": [ + "UserPreference1", + "UserPreference2" + ] + } + } + } } \ No newline at end of file diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json index 1d75f2a88e8e..8d4b59b7ae34 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json @@ -622,4 +622,4 @@ "security": [{ "azure_auth": ["user_impersonation"] }] -} +} diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/CreateSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/CreateSuppression.json index 91305b1ee7c2..6df4e303bb2e 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/CreateSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/CreateSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/DeleteSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/DeleteSuppression.json index 9f30d0036037..0c14f9e3f42d 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/DeleteSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/DeleteSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GenerateRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GenerateRecommendations.json index 7a705e817cd8..bf3278778edc 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GenerateRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GenerateRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "api-version": "2016-07-12-preview" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetRecommendationDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetRecommendationDetail.json index adee0401e12a..620d5e690cbc 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetRecommendationDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetRecommendationDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetSuppressionDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetSuppressionDetail.json index 308bb1d3a1b0..5873286935f6 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetSuppressionDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/GetSuppressionDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListRecommendations.json index c63aa9fae45c..dd0f346b1e72 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "$top": 10, diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListSuppressions.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListSuppressions.json index b8d5e5c6947f..b7f062dacf52 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListSuppressions.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/ListSuppressions.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId1", "api-version": "2016-07-12-preview" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/PollGenerateRecommendationsStatus.json b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/PollGenerateRecommendationsStatus.json index 5f5e596cf74f..51dd5cd73f43 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/PollGenerateRecommendationsStatus.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/preview/2016-07-12-preview/examples/PollGenerateRecommendationsStatus.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "operationId": "operationGUID", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/advisor.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/advisor.json index 0ef457207732..ab02676e3a8c 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/advisor.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/advisor.json @@ -664,4 +664,4 @@ ] } ] -} +} diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/CreateSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/CreateSuppression.json index 4e21dbffe487..631dc3b85f20 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/CreateSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/CreateSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/DeleteSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/DeleteSuppression.json index f0cecf36ffca..c23c87b0e5d8 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/DeleteSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/DeleteSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GenerateRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GenerateRecommendations.json index ffbab8d31b90..3783b1ab1e49 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GenerateRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GenerateRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "api-version": "2017-03-31" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetRecommendationDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetRecommendationDetail.json index 54b572fcd02c..7de16bc444da 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetRecommendationDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetRecommendationDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetSuppressionDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetSuppressionDetail.json index 2fd85b9dbe52..911fee6e4a5e 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetSuppressionDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/GetSuppressionDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListRecommendations.json index 32861348c99c..4bae50588ee3 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "$top": 10, diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListSuppressions.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListSuppressions.json index c20f9b89e5de..c5fc14bd98f7 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListSuppressions.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/ListSuppressions.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId1", "api-version": "2017-03-31" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/PollGenerateRecommendationsStatus.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/PollGenerateRecommendationsStatus.json index d96db0b845a8..b7891022245f 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/PollGenerateRecommendationsStatus.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-03-31/examples/PollGenerateRecommendationsStatus.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "operationId": "operationGUID", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateConfiguration.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateConfiguration.json index d27317a85904..71393b2282f1 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateConfiguration.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateConfiguration.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "resourceGroup": "resourceGroup", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateSuppression.json index a79518dd1027..22640b0b199e 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/CreateSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/DeleteSuppression.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/DeleteSuppression.json index 5c283a78db1a..37f840dde45e 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/DeleteSuppression.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/DeleteSuppression.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/EmptyResponse.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/EmptyResponse.json index 55da77db6699..e102d6fb82af 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/EmptyResponse.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/EmptyResponse.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "operationId": "operationGUID", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GenerateRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GenerateRecommendations.json index 07d19241da3f..501637403253 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GenerateRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GenerateRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "api-version": "2017-04-19" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetRecommendationDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetRecommendationDetail.json index 31b0333bf33e..d61b81de1ab5 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetRecommendationDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetRecommendationDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetSuppressionDetail.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetSuppressionDetail.json index 63f1ec9bc44b..7365e75a34cd 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetSuppressionDetail.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/GetSuppressionDetail.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri": "resourceUri", "recommendationId": "recommendationId", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListConfigurations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListConfigurations.json index b4d99dd2da68..fe848d92672f 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListConfigurations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListConfigurations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "resourceGroup": "resourceGroup", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListRecommendations.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListRecommendations.json index 30d374879e4a..54574ce6881f 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListRecommendations.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListRecommendations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "$top": 10, diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListSuppressions.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListSuppressions.json index 25fff9d3e0bc..c049aa9b5cab 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListSuppressions.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/ListSuppressions.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId1", "api-version": "2017-04-19" diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/PollGenerateRecommendationsStatus.json b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/PollGenerateRecommendationsStatus.json index 9bbf69151ef7..1644549c02fc 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/PollGenerateRecommendationsStatus.json +++ b/specification/advisor/resource-manager/Microsoft.Advisor/stable/2017-04-19/examples/PollGenerateRecommendationsStatus.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "operationId": "operationGUID", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json index 0774d680e41d..f12ad19d32b1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json @@ -1303,4 +1303,4 @@ }, "parameters": { } -} +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimnetworkstatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimnetworkstatus.json index 52020b4c52b4..7c75eed6844a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimnetworkstatus.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimnetworkstatus.json @@ -145,4 +145,4 @@ }, "parameters": { } -} +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnnotationsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnnotationsList.json index 0a8b6b1afb7c..62c3742b9822 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnnotationsList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnnotationsList.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-component", - "start": "2018-02-05T00%253A30%253A00.000Z", - "end": "2018-02-06T00%253A33A00.000Z" - }, - "responses": { - "200": { - "body": [ - { - "AnnotationName":"InsightsPortal-20180126-1", - "Id":"4de4524f-fca5-44a8-b7e6-a67d5107796e", - "Category":"Deployment", - "Properties":"{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180126.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180126.1.\",\"ReleaseId\":\"31075\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31075\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"AIMON VIP SWAP\",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180126-1\"}", - "EventTime":"2018-01-29T20:30:31+00:00", - "RelatedAnnotation":null - }, - { - "AnnotationName":"InsightsPortal-20180125-1", - "Id":"9a82214f-8f98-4699-b5bc-cad6101ed223", - "Category":"Deployment", - "Properties":"{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180125.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180125.1.\",\"ReleaseId\":\"31035\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31035\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"Prod VIP Swap \",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180125-1\"}", - "EventTime":"2018-01-29T20:38:35+00:00", - "RelatedAnnotation":null - } - ] - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component", + "start": "2018-02-05T00%253A30%253A00.000Z", + "end": "2018-02-06T00%253A33A00.000Z" + }, + "responses": { + "200": { + "body": [ + { + "AnnotationName":"InsightsPortal-20180126-1", + "Id":"4de4524f-fca5-44a8-b7e6-a67d5107796e", + "Category":"Deployment", + "Properties":"{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180126.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180126.1.\",\"ReleaseId\":\"31075\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31075\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"AIMON VIP SWAP\",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180126-1\"}", + "EventTime":"2018-01-29T20:30:31+00:00", + "RelatedAnnotation":null + }, + { + "AnnotationName":"InsightsPortal-20180125-1", + "Id":"9a82214f-8f98-4699-b5bc-cad6101ed223", + "Category":"Deployment", + "Properties":"{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180125.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180125.1.\",\"ReleaseId\":\"31035\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31035\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"Prod VIP Swap \",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180125-1\"}", + "EventTime":"2018-01-29T20:38:35+00:00", + "RelatedAnnotation":null + } + ] + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteAdd.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteAdd.json index b86643d49d8d..90717666c01c 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteAdd.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteAdd.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "resourceGroupName": "my-resource-group", - "resourceName": "my-ai-component", - "subscriptionId": "subid", - "favoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "favoriteProperties": { - "Name": "Blah Blah Blah", - "Config": "{\"MEDataModelRawJSON\":\"{\\n \\\"version\\\": \\\"1.4.1\\\",\\n \\\"isCustomDataModel\\\": true,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\n \\\"chartType\\\": \\\"Area\\\",\\n \\\"chartHeight\\\": 4,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Sum\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"fail\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\n \\\"chartType\\\": \\\"Area\\\",\\n \\\"chartHeight\\\": 2,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/duration\\\",\\n \\\"metricAggregation\\\": \\\"Avg\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Avg\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"greenHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\n \\\"chartType\\\": \\\"Bar\\\",\\n \\\"chartHeight\\\": 4,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/duration\\\",\\n \\\"metricAggregation\\\": \\\"Avg\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Avg\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"magentaHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\n \\\"grouping\\\": {\\n \\\"kind\\\": \\\"ByDimension\\\",\\n \\\"dimension\\\": \\\"context.application.version\\\"\\n },\\n \\\"chartType\\\": \\\"Grid\\\",\\n \\\"chartHeight\\\": 1,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"basicException.count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"\\n },\\n {\\n \\\"id\\\": \\\"requestFailed.count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": true,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"blueHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n }\\n ],\\n \\\"currentFilter\\\": {\\n \\\"eventTypes\\\": [\\n 1,\\n 2\\n ],\\n \\\"typeFacets\\\": {},\\n \\\"isPermissive\\\": false\\n },\\n \\\"timeContext\\\": {\\n \\\"durationMs\\\": 75600000,\\n \\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\n \\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\n \\\"isInitialTime\\\": false,\\n \\\"grain\\\": 1,\\n \\\"useDashboardTimeRange\\\": false\\n },\\n \\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\n \\\"timeSource\\\": 0\\n}\"}", - "Version": "ME", - "FavoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": null, - "Tags": [ - "TagSample01", - "TagSample02" - ], - "Category": null, - "IsGeneratedFromTemplate": false - } - }, - "responses": { - "200": { - "body": { - "Name": "Blah Blah Blah", - "Config": "{\"MEDataModelRawJSON\":{\n \"version\": \"1.4.1\",\n \"isCustomDataModel\": true,\n \"items\": [\n {\n \"id\": \"90a7134d-9a38-4c25-88d3-a495209873eb\",\n \"chartType\": \"Area\",\n \"chartHeight\": 4,\n \"metrics\": [\n {\n \"id\": \"preview/requests/count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-d0\"\n }\n],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Sum\",\n \"percentage\": false,\n \"palette\": \"fail\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"0c289098-88e8-4010-b212-546815cddf70\",\n \"chartType\": \"Area\",\n \"chartHeight\": 2,\n \"metrics\": [\n {\n \"id\": \"preview/requests/duration\",\n \"metricAggregation\": \"Avg\",\n \"color\": \"msportalfx-bgcolor-j1\"\n }\n ],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Avg\",\n \"percentage\": false,\n \"palette\": \"greenHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"cbdaab6f-a808-4f71-aca5-b3976cbb7345\",\n \"chartType\": \"Bar\",\n \"chartHeight\": 4,\n \"metrics\": [\n {\n \"id\": \"preview/requests/duration\",\n \"metricAggregation\": \"Avg\",\n \"color\": \"msportalfx-bgcolor-d0\"\n }\n ],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Avg\",\n \"percentage\": false,\n \"palette\": \"magentaHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\",\n \"grouping\": {\n \"kind\": \"ByDimension\",\n \"dimension\": \"context.application.version\"\n },\n \"chartType\": \"Grid\",\n \"chartHeight\": 1,\n \"metrics\": [\n {\n \"id\": \"basicException.count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-g0\"\n },\n {\n \"id\": \"requestFailed.count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-f0s2\"\n }\n ],\n \"priorPeriod\": true,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"percentage\": false,\n \"palette\": \"blueHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n }\n ],\n \"currentFilter\": {\n \"eventTypes\": [\n 1,\n 2\n ],\n \"typeFacets\": {},\n \"isPermissive\": false\n },\n \"timeContext\": {\n \"durationMs\": 75600000,\n \"endTime\": \"2018-01-31T20:30:00.000Z\",\n \"createdTime\": \"2018-01-31T23:54:26.280Z\",\n \"isInitialTime\": false,\n \"grain\": 1,\n \"useDashboardTimeRange\": false\n },\n \"jsonUri\": \"Favorite_BlankChart\",\n \"timeSource\": 0\n}\"}", - "Version": "ME", - "FavoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", - "FavoriteType": "shared", - "SourceType": "", - "TimeModified": "2018-02-02T23:18:32.1850959Z", - "Tags": [ - "TagSample01", - "TagSample02" - ], - "Category": "", - "IsGeneratedFromTemplate": false - } - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "resourceGroupName": "my-resource-group", + "resourceName": "my-ai-component", + "subscriptionId": "subid", + "favoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", + "favoriteProperties": { + "Name": "Blah Blah Blah", + "Config": "{\"MEDataModelRawJSON\":\"{\\n \\\"version\\\": \\\"1.4.1\\\",\\n \\\"isCustomDataModel\\\": true,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\n \\\"chartType\\\": \\\"Area\\\",\\n \\\"chartHeight\\\": 4,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Sum\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"fail\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\n \\\"chartType\\\": \\\"Area\\\",\\n \\\"chartHeight\\\": 2,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/duration\\\",\\n \\\"metricAggregation\\\": \\\"Avg\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Avg\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"greenHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\n \\\"chartType\\\": \\\"Bar\\\",\\n \\\"chartHeight\\\": 4,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"preview/requests/duration\\\",\\n \\\"metricAggregation\\\": \\\"Avg\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": false,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"aggregation\\\": \\\"Avg\\\",\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"magentaHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n },\\n {\\n \\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\n \\\"grouping\\\": {\\n \\\"kind\\\": \\\"ByDimension\\\",\\n \\\"dimension\\\": \\\"context.application.version\\\"\\n },\\n \\\"chartType\\\": \\\"Grid\\\",\\n \\\"chartHeight\\\": 1,\\n \\\"metrics\\\": [\\n {\\n \\\"id\\\": \\\"basicException.count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"\\n },\\n {\\n \\\"id\\\": \\\"requestFailed.count\\\",\\n \\\"metricAggregation\\\": \\\"Sum\\\",\\n \\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"\\n }\\n ],\\n \\\"priorPeriod\\\": true,\\n \\\"clickAction\\\": {\\n \\\"defaultBlade\\\": \\\"SearchBlade\\\"\\n },\\n \\\"horizontalBars\\\": true,\\n \\\"showOther\\\": true,\\n \\\"percentage\\\": false,\\n \\\"palette\\\": \\\"blueHues\\\",\\n \\\"yAxisOption\\\": 0,\\n \\\"title\\\": \\\"\\\"\\n }\\n ],\\n \\\"currentFilter\\\": {\\n \\\"eventTypes\\\": [\\n 1,\\n 2\\n ],\\n \\\"typeFacets\\\": {},\\n \\\"isPermissive\\\": false\\n },\\n \\\"timeContext\\\": {\\n \\\"durationMs\\\": 75600000,\\n \\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\n \\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\n \\\"isInitialTime\\\": false,\\n \\\"grain\\\": 1,\\n \\\"useDashboardTimeRange\\\": false\\n },\\n \\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\n \\\"timeSource\\\": 0\\n}\"}", + "Version": "ME", + "FavoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": null, + "Tags": [ + "TagSample01", + "TagSample02" + ], + "Category": null, + "IsGeneratedFromTemplate": false + } + }, + "responses": { + "200": { + "body": { + "Name": "Blah Blah Blah", + "Config": "{\"MEDataModelRawJSON\":{\n \"version\": \"1.4.1\",\n \"isCustomDataModel\": true,\n \"items\": [\n {\n \"id\": \"90a7134d-9a38-4c25-88d3-a495209873eb\",\n \"chartType\": \"Area\",\n \"chartHeight\": 4,\n \"metrics\": [\n {\n \"id\": \"preview/requests/count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-d0\"\n }\n],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Sum\",\n \"percentage\": false,\n \"palette\": \"fail\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"0c289098-88e8-4010-b212-546815cddf70\",\n \"chartType\": \"Area\",\n \"chartHeight\": 2,\n \"metrics\": [\n {\n \"id\": \"preview/requests/duration\",\n \"metricAggregation\": \"Avg\",\n \"color\": \"msportalfx-bgcolor-j1\"\n }\n ],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Avg\",\n \"percentage\": false,\n \"palette\": \"greenHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"cbdaab6f-a808-4f71-aca5-b3976cbb7345\",\n \"chartType\": \"Bar\",\n \"chartHeight\": 4,\n \"metrics\": [\n {\n \"id\": \"preview/requests/duration\",\n \"metricAggregation\": \"Avg\",\n \"color\": \"msportalfx-bgcolor-d0\"\n }\n ],\n \"priorPeriod\": false,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"aggregation\": \"Avg\",\n \"percentage\": false,\n \"palette\": \"magentaHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n },\n {\n \"id\": \"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\",\n \"grouping\": {\n \"kind\": \"ByDimension\",\n \"dimension\": \"context.application.version\"\n },\n \"chartType\": \"Grid\",\n \"chartHeight\": 1,\n \"metrics\": [\n {\n \"id\": \"basicException.count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-g0\"\n },\n {\n \"id\": \"requestFailed.count\",\n \"metricAggregation\": \"Sum\",\n \"color\": \"msportalfx-bgcolor-f0s2\"\n }\n ],\n \"priorPeriod\": true,\n \"clickAction\": {\n \"defaultBlade\": \"SearchBlade\"\n },\n \"horizontalBars\": true,\n \"showOther\": true,\n \"percentage\": false,\n \"palette\": \"blueHues\",\n \"yAxisOption\": 0,\n \"title\": \"\"\n }\n ],\n \"currentFilter\": {\n \"eventTypes\": [\n 1,\n 2\n ],\n \"typeFacets\": {},\n \"isPermissive\": false\n },\n \"timeContext\": {\n \"durationMs\": 75600000,\n \"endTime\": \"2018-01-31T20:30:00.000Z\",\n \"createdTime\": \"2018-01-31T23:54:26.280Z\",\n \"isInitialTime\": false,\n \"grain\": 1,\n \"useDashboardTimeRange\": false\n },\n \"jsonUri\": \"Favorite_BlankChart\",\n \"timeSource\": 0\n}\"}", + "Version": "ME", + "FavoriteId": "deadb33f-8bee-4d3b-a059-9be8dac93960", + "FavoriteType": "shared", + "SourceType": "", + "TimeModified": "2018-02-02T23:18:32.1850959Z", + "Tags": [ + "TagSample01", + "TagSample02" + ], + "Category": "", + "IsGeneratedFromTemplate": false + } + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteDelete.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteDelete.json index 85705a58c12c..29eb05b19ade 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteDelete.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteDelete.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-ai-component", - "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" - }, - "responses": { - "200": { - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-ai-component", + "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" + }, + "responses": { + "200": { + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteGet.json index 15a8003d2ffb..06c083a7be12 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-ai-component", - "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" - }, - "responses": { - "200": { - "body": { - "Name": "Example Search Blade Favorite", - "Config": "{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}", - "Version": "Search", - "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": "2018-01-31T23:59:25.4594264Z", - "Tags": ["SampleTag1", "SampleTag2"], - "Category": null, - "IsGeneratedFromTemplate" : false - } - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-ai-component", + "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2" + }, + "responses": { + "200": { + "body": { + "Name": "Example Search Blade Favorite", + "Config": "{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}", + "Version": "Search", + "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": "2018-01-31T23:59:25.4594264Z", + "Tags": ["SampleTag1", "SampleTag2"], + "Category": null, + "IsGeneratedFromTemplate" : false + } + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteUpdate.json index e9c8a0203e5a..347c6604c871 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoriteUpdate.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-ai-component", - "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", - "favoriteProperties": { - "Name": "Derek Changed This", - "Config": "{\"MEDataModelRawJSON\":\"{\\\"version\\\": \\\"1.4.1\\\",\\\"isCustomDataModel\\\": true,\\\"items\\\": [{\\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Sum\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"fail\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 2,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"greenHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\\"chartType\\\": \\\"Bar\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"magentaHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\\"grouping\\\": {\\\"kind\\\": \\\"ByDimension\\\",\\\"dimension\\\": \\\"context.application.version\\\"},\\\"chartType\\\": \\\"Grid\\\",\\\"chartHeight\\\": 1,\\\"metrics\\\": [{\\\"id\\\": \\\"basicException.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"},{\\\"id\\\": \\\"requestFailed.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"}],\\\"priorPeriod\\\": true,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"percentage\\\": false,\\\"palette\\\": \\\"blueHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"}],\\\"currentFilter\\\": {\\\"eventTypes\\\": [1,2],\\\"typeFacets\\\": {},\\\"isPermissive\\\": false},\\\"timeContext\\\": {\\\"durationMs\\\": 75600000,\\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\\"isInitialTime\\\": false,\\\"grain\\\": 1,\\\"useDashboardTimeRange\\\": false},\\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\\"timeSource\\\": 0}\"}", - "Version": "ME", - "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": "2018-02-02T18:39:11.6569686Z", - "Tags": [ - "TagSample01", - "TagSample02", - "TagSample03" - ], - "Category": null, - "IsGeneratedFromTemplate": false - } - }, - "responses": { - "200": { - "body": { - "Name": "Derek Changed This", - "Config": "{\"MEDataModelRawJSON\":\"{\\\"version\\\": \\\"1.4.1\\\",\\\"isCustomDataModel\\\": true,\\\"items\\\": [{\\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Sum\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"fail\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 2,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"greenHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\\"chartType\\\": \\\"Bar\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"magentaHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\\"grouping\\\": {\\\"kind\\\": \\\"ByDimension\\\",\\\"dimension\\\": \\\"context.application.version\\\"},\\\"chartType\\\": \\\"Grid\\\",\\\"chartHeight\\\": 1,\\\"metrics\\\": [{\\\"id\\\": \\\"basicException.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"},{\\\"id\\\": \\\"requestFailed.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"}],\\\"priorPeriod\\\": true,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"percentage\\\": false,\\\"palette\\\": \\\"blueHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"}],\\\"currentFilter\\\": {\\\"eventTypes\\\": [1,2],\\\"typeFacets\\\": {},\\\"isPermissive\\\": false},\\\"timeContext\\\": {\\\"durationMs\\\": 75600000,\\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\\"isInitialTime\\\": false,\\\"grain\\\": 1,\\\"useDashboardTimeRange\\\": false},\\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\\"timeSource\\\": 0}\"}", - "Version": "ME", - "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": "2018-02-02T18:39:11.6569686Z", - "Tags": [ - "TagSample01", - "TagSample02", - "TagSample03" - ], - "Category": null, - "IsGeneratedFromTemplate": false - } - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-ai-component", + "favoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", + "favoriteProperties": { + "Name": "Derek Changed This", + "Config": "{\"MEDataModelRawJSON\":\"{\\\"version\\\": \\\"1.4.1\\\",\\\"isCustomDataModel\\\": true,\\\"items\\\": [{\\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Sum\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"fail\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 2,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"greenHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\\"chartType\\\": \\\"Bar\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"magentaHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\\"grouping\\\": {\\\"kind\\\": \\\"ByDimension\\\",\\\"dimension\\\": \\\"context.application.version\\\"},\\\"chartType\\\": \\\"Grid\\\",\\\"chartHeight\\\": 1,\\\"metrics\\\": [{\\\"id\\\": \\\"basicException.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"},{\\\"id\\\": \\\"requestFailed.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"}],\\\"priorPeriod\\\": true,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"percentage\\\": false,\\\"palette\\\": \\\"blueHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"}],\\\"currentFilter\\\": {\\\"eventTypes\\\": [1,2],\\\"typeFacets\\\": {},\\\"isPermissive\\\": false},\\\"timeContext\\\": {\\\"durationMs\\\": 75600000,\\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\\"isInitialTime\\\": false,\\\"grain\\\": 1,\\\"useDashboardTimeRange\\\": false},\\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\\"timeSource\\\": 0}\"}", + "Version": "ME", + "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": "2018-02-02T18:39:11.6569686Z", + "Tags": [ + "TagSample01", + "TagSample02", + "TagSample03" + ], + "Category": null, + "IsGeneratedFromTemplate": false + } + }, + "responses": { + "200": { + "body": { + "Name": "Derek Changed This", + "Config": "{\"MEDataModelRawJSON\":\"{\\\"version\\\": \\\"1.4.1\\\",\\\"isCustomDataModel\\\": true,\\\"items\\\": [{\\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Sum\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"fail\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 2,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"greenHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\\"chartType\\\": \\\"Bar\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"magentaHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\\"grouping\\\": {\\\"kind\\\": \\\"ByDimension\\\",\\\"dimension\\\": \\\"context.application.version\\\"},\\\"chartType\\\": \\\"Grid\\\",\\\"chartHeight\\\": 1,\\\"metrics\\\": [{\\\"id\\\": \\\"basicException.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"},{\\\"id\\\": \\\"requestFailed.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"}],\\\"priorPeriod\\\": true,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"percentage\\\": false,\\\"palette\\\": \\\"blueHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"}],\\\"currentFilter\\\": {\\\"eventTypes\\\": [1,2],\\\"typeFacets\\\": {},\\\"isPermissive\\\": false},\\\"timeContext\\\": {\\\"durationMs\\\": 75600000,\\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\\"isInitialTime\\\": false,\\\"grain\\\": 1,\\\"useDashboardTimeRange\\\": false},\\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\\"timeSource\\\": 0}\"}", + "Version": "ME", + "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": "2018-02-02T18:39:11.6569686Z", + "Tags": [ + "TagSample01", + "TagSample02", + "TagSample03" + ], + "Category": null, + "IsGeneratedFromTemplate": false + } + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoritesList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoritesList.json index 810a22f7e59b..0babea366276 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoritesList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/FavoritesList.json @@ -1,38 +1,38 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-ai-component" - }, - "responses": { - "200": { - "body": [ - { - "Name": "Example Metric Chart Favorite", - "Config": "blah blah", - "Version": "ME", - "FavoriteId": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": "2018-01-31T23:56:16.008902Z", - "Tags": [], - "Category": null, - "IsGeneratedFromTemplate": false - }, - { - "Name": "Example Search Blade Favorite", - "Config": "{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}", - "Version": "Search", - "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", - "FavoriteType": "shared", - "SourceType": null, - "TimeModified": "2018-01-31T23:59:25.4594264Z", - "Tags": ["SampleTag01", "SampleTag2"], - "Category": null, - "IsGeneratedFromTemplate" : false - } - ] - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-ai-component" + }, + "responses": { + "200": { + "body": [ + { + "Name": "Example Metric Chart Favorite", + "Config": "blah blah", + "Version": "ME", + "FavoriteId": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": "2018-01-31T23:56:16.008902Z", + "Tags": [], + "Category": null, + "IsGeneratedFromTemplate": false + }, + { + "Name": "Example Search Blade Favorite", + "Config": "{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}", + "Version": "Search", + "FavoriteId": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2", + "FavoriteType": "shared", + "SourceType": null, + "TimeModified": "2018-01-31T23:59:25.4594264Z", + "Tags": ["SampleTag01", "SampleTag2"], + "Category": null, + "IsGeneratedFromTemplate" : false + } + ] + } + } } \ No newline at end of file diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestLocationsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestLocationsList.json index f2c22768be82..36cb241e71ae 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestLocationsList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/WebTestLocationsList.json @@ -1,78 +1,78 @@ -{ - "parameters": { - "api-version": "2015-05-01", - "subscriptionId": "subid", - "resourceGroupName": "my-resource-group", - "resourceName": "my-component" - }, - "responses": { - "200": { - "body": [ - { - "DisplayName": "US : IL-Chicago", - "Tag": "us-il-ch1-azr" - }, - { - "DisplayName": "NL : Amsterdam", - "Tag": "emea-nl-ams-azr" - }, - { - "DisplayName": "SG : Singapore", - "Tag": "apac-sg-sin-azr" - }, - { - "DisplayName": "US : CA-San Jose", - "Tag": "us-ca-sjc-azr" - }, - { - "DisplayName": "US : TX-San Antonio", - "Tag": "us-tx-sn1-azr" - }, - { - "DisplayName": "US : VA-Ashburn", - "Tag": "us-va-ash-azr" - }, - { - "DisplayName": "HK : Hong Kong", - "Tag": "apac-hk-hkn-azr" - }, - { - "DisplayName": "IE : Dublin", - "Tag": "emea-gb-db3-azr" - }, - { - "DisplayName": "JP : Kawaguchi", - "Tag": "apac-jp-kaw-edge" - }, - { - "DisplayName": "AU : Sydney", - "Tag": "emea-au-syd-edge" - }, - { - "DisplayName": "CH : Zurich", - "Tag": "emea-ch-zrh-edge" - }, - { - "DisplayName": "FR : Paris", - "Tag": "emea-fr-pra-edge" - }, - { - "DisplayName": "RU : Moscow", - "Tag": "emea-ru-msa-edge" - }, - { - "DisplayName": "SE : Stockholm", - "Tag": "emea-se-sto-edge" - }, - { - "DisplayName": "BR : Sao Paulo", - "Tag": "latam-br-gru-edge" - }, - { - "DisplayName": "US : FL-Miami", - "Tag": "us-fl-mia-edge" - } - ] - } - } +{ + "parameters": { + "api-version": "2015-05-01", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "resourceName": "my-component" + }, + "responses": { + "200": { + "body": [ + { + "DisplayName": "US : IL-Chicago", + "Tag": "us-il-ch1-azr" + }, + { + "DisplayName": "NL : Amsterdam", + "Tag": "emea-nl-ams-azr" + }, + { + "DisplayName": "SG : Singapore", + "Tag": "apac-sg-sin-azr" + }, + { + "DisplayName": "US : CA-San Jose", + "Tag": "us-ca-sjc-azr" + }, + { + "DisplayName": "US : TX-San Antonio", + "Tag": "us-tx-sn1-azr" + }, + { + "DisplayName": "US : VA-Ashburn", + "Tag": "us-va-ash-azr" + }, + { + "DisplayName": "HK : Hong Kong", + "Tag": "apac-hk-hkn-azr" + }, + { + "DisplayName": "IE : Dublin", + "Tag": "emea-gb-db3-azr" + }, + { + "DisplayName": "JP : Kawaguchi", + "Tag": "apac-jp-kaw-edge" + }, + { + "DisplayName": "AU : Sydney", + "Tag": "emea-au-syd-edge" + }, + { + "DisplayName": "CH : Zurich", + "Tag": "emea-ch-zrh-edge" + }, + { + "DisplayName": "FR : Paris", + "Tag": "emea-fr-pra-edge" + }, + { + "DisplayName": "RU : Moscow", + "Tag": "emea-ru-msa-edge" + }, + { + "DisplayName": "SE : Stockholm", + "Tag": "emea-se-sto-edge" + }, + { + "DisplayName": "BR : Sao Paulo", + "Tag": "latam-br-gru-edge" + }, + { + "DisplayName": "US : FL-Miami", + "Tag": "us-fl-mia-edge" + } + ] + } + } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json index e9221ee9bcc2..affbcace743a 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json @@ -1,151 +1,151 @@ -{ - "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationName": "testpatch", - "api-version": "2017-05-15-preview", - "parameters": { - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "duration": "PT2H0M", - "windows": { - "excludedKbNumbers": [ - "168934", - "168973" - ], - "includedUpdateClassifications": "Critical", - "rebootSetting": "IfRequired" - }, - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ] - }, - "scheduleInfo": { - "frequency": "Hour", - "startTime": "2017-10-19T12:22:57+00:00", - "timeZone": "America/Los_Angeles", - "interval": 1, - "expiryTime": "2018-11-09T11:22:57+00:00", - "advancedSchedule": { - "weekDays": [ - "Monday", - "Thursday" - ] - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ] - }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles", - "advancedSchedule": {} - }, - "provisioningState": "Provisioning", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "createdBy": "adam@contoso.com", - "lastModifiedBy": "adam@contoso.com", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" - } - } - }, - "201": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ] - }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles" - }, - "provisioningState": "Provisioning", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationName": "testpatch", + "api-version": "2017-05-15-preview", + "parameters": { + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "duration": "PT2H0M", + "windows": { + "excludedKbNumbers": [ + "168934", + "168973" + ], + "includedUpdateClassifications": "Critical", + "rebootSetting": "IfRequired" + }, + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "frequency": "Hour", + "startTime": "2017-10-19T12:22:57+00:00", + "timeZone": "America/Los_Angeles", + "interval": 1, + "expiryTime": "2018-11-09T11:22:57+00:00", + "advancedSchedule": { + "weekDays": [ + "Monday", + "Thursday" + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420.0, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480.0, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420.0, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles", + "advancedSchedule": {} + }, + "provisioningState": "Provisioning", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "createdBy": "adam@contoso.com", + "lastModifiedBy": "adam@contoso.com", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420.0, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480.0, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420.0, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles" + }, + "provisioningState": "Provisioning", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } + } + } + } +} diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json index 3b696f9a7712..d7f9dc78dce8 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationName": "mypatch", - "api-version": "2017-05-15-preview", - "body": {} - }, - "responses": { - "200": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ] - }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles" - }, - "provisioningState": "Provisioning", - "createdBy": "eve@contoso.com", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" - } - } - } - } +{ + "parameters": { + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationName": "mypatch", + "api-version": "2017-05-15-preview", + "body": {} + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420.0, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480.0, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420.0, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles" + }, + "provisioningState": "Provisioning", + "createdBy": "eve@contoso.com", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } + } + } + } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByModuleAndType.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByModuleAndType.json index 0810ffe55774..be81a3d37b4e 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByModuleAndType.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByModuleAndType.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "subid", - "resourceGroupName": "rg", - "automationAccountName": "MyAutomationAccount", - "moduleName": "MyModule", - "typeName": "MyCustomType", - "api-version": "2015-10-31" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "name": "Name", - "type": "System.String" - }, - { - "name": "Id", - "type": "System.Integer" - }, - { - "name": "Details", - "type": "MyModule.AnotherCustomType" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyAutomationAccount", + "moduleName": "MyModule", + "typeName": "MyCustomType", + "api-version": "2015-10-31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Name", + "type": "System.String" + }, + { + "name": "Id", + "type": "System.Integer" + }, + { + "name": "Details", + "type": "MyModule.AnotherCustomType" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByType.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByType.json index f0b2e94dad51..404115bcb94e 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByType.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listFieldsByType.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "subid", - "resourceGroupName": "rg", - "automationAccountName": "MyAutomationAccount", - "typeName": "MyCustomType", - "api-version": "2015-10-31" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "name": "Name", - "type": "System.String" - }, - { - "name": "Id", - "type": "System.Integer" - }, - { - "name": "Details", - "type": "MyModule.AnotherCustomType" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "automationAccountName": "MyAutomationAccount", + "typeName": "MyCustomType", + "api-version": "2015-10-31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Name", + "type": "System.String" + }, + { + "name": "Id", + "type": "System.Integer" + }, + { + "name": "Details", + "type": "MyModule.AnotherCustomType" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json index 2e489323cdfd..c6e8495c07d7 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Operations/List.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/InfraRole/Restart.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/InfraRole/Restart.json index a26f7ab3ee5e..40ee2c1f1118 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/InfraRole/Restart.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/examples/InfraRole/Restart.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2016-05-01", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "System.local", - "location": "local", - "infraRole": "BackupRestoreResourceProvider" - }, - "responses": { - "200": {}, - "202": {} - } -} +{ + "parameters": { + "api-version": "2016-05-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "infraRole": "BackupRestoreResourceProvider" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json index 2e489323cdfd..c6e8495c07d7 100644 --- a/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json +++ b/specification/azsadmin/resource-manager/network/Microsoft.Network.Admin/preview/2015-06-15/examples/Operations/List.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "api-version": "2016-05-01" - }, - "responses": { - "200": { - "body": { - "value": [], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "api-version": "2016-05-01" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": "" + } + } + } +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json index 450e958a171b..587918a42040 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json @@ -1,170 +1,170 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/acquisitions": { - "get": { - "x-ms-examples": { - "Returns a list of page BLOB acquistions.": { - "$ref": "./examples/Acquisitions/List.json" - } - }, - "tags": [ - "Acquisitions" - ], - "operationId": "Acquisitions_List", - "description": "Returns a list of BLOB acquistions.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/FilterParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of acquisitions has been returned.", - "schema": { - "$ref": "acquisitions.json#/definitions/AcquisitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "AcquisitionStatus": { - "description": "The status of page BLOB acquisition.", - "type": "string", - "enum": [ - "InProgress", - "Success", - "Failed" - ], - "x-ms-enum": { - "name": "AcquisitionStatus", - "modelAsString": true - } - }, - "AcquisitionProperties": { - "description": "The Properties of page BLOB acquisition.", - "type": "object", - "properties": { - "filePath": { - "description": "The file path of the page BLOB file on storage cluster.", - "type": "string", - "readOnly": true - }, - "maximumblobsize": { - "description": "The maximum size of the page BLOB.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "status": { - "description": "The status of the page BLOB acquisition.", - "$ref": "acquisitions.json#/definitions/AcquisitionStatus", - "readOnly": true - }, - "susbcriptionid": { - "description": "ID of the subscription associated with the page BLOB.", - "type": "string", - "readOnly": true - }, - "storageaccount": { - "description": "The storage account that holds the page BLOB.", - "type": "string", - "readOnly": true - }, - "container": { - "description": "The container associated with the the page BLOB.", - "type": "string", - "readOnly": true - }, - "blob": { - "description": "The name of the page BLOB.", - "type": "string", - "readOnly": true - }, - "acquisitionid": { - "description": "The ID of page BLOB acquisition.", - "type": "string", - "readOnly": true - } - } - }, - "Acquisition": { - "description": "The acquisition of the page BLOB.", - "type": "object", - "properties": { - "properties": { - "description": "The properties of the page blob acquisition.", - "x-ms-client-flatten": true, - "$ref": "acquisitions.json#/definitions/AcquisitionProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "AcquisitionList": { - "description": "The list of page BLOB acquisitions.", - "type": "array", - "items": { - "$ref": "acquisitions.json#/definitions/Acquisition" - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/acquisitions": { + "get": { + "x-ms-examples": { + "Returns a list of page BLOB acquistions.": { + "$ref": "./examples/Acquisitions/List.json" + } + }, + "tags": [ + "Acquisitions" + ], + "operationId": "Acquisitions_List", + "description": "Returns a list of BLOB acquistions.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of acquisitions has been returned.", + "schema": { + "$ref": "acquisitions.json#/definitions/AcquisitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "AcquisitionStatus": { + "description": "The status of page BLOB acquisition.", + "type": "string", + "enum": [ + "InProgress", + "Success", + "Failed" + ], + "x-ms-enum": { + "name": "AcquisitionStatus", + "modelAsString": true + } + }, + "AcquisitionProperties": { + "description": "The Properties of page BLOB acquisition.", + "type": "object", + "properties": { + "filePath": { + "description": "The file path of the page BLOB file on storage cluster.", + "type": "string", + "readOnly": true + }, + "maximumblobsize": { + "description": "The maximum size of the page BLOB.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "status": { + "description": "The status of the page BLOB acquisition.", + "$ref": "acquisitions.json#/definitions/AcquisitionStatus", + "readOnly": true + }, + "susbcriptionid": { + "description": "ID of the subscription associated with the page BLOB.", + "type": "string", + "readOnly": true + }, + "storageaccount": { + "description": "The storage account that holds the page BLOB.", + "type": "string", + "readOnly": true + }, + "container": { + "description": "The container associated with the the page BLOB.", + "type": "string", + "readOnly": true + }, + "blob": { + "description": "The name of the page BLOB.", + "type": "string", + "readOnly": true + }, + "acquisitionid": { + "description": "The ID of page BLOB acquisition.", + "type": "string", + "readOnly": true + } + } + }, + "Acquisition": { + "description": "The acquisition of the page BLOB.", + "type": "object", + "properties": { + "properties": { + "description": "The properties of the page blob acquisition.", + "x-ms-client-flatten": true, + "$ref": "acquisitions.json#/definitions/AcquisitionProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "AcquisitionList": { + "description": "The list of page BLOB acquisitions.", + "type": "array", + "items": { + "$ref": "acquisitions.json#/definitions/Acquisition" + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json index 377ed7d08f7a..7581c851cbaa 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json @@ -1,245 +1,245 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the BLOB service.": { - "$ref": "./examples/BlobService/Get.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_Get", - "description": "Returns the BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The BLOB service has been returned.", - "schema": { - "$ref": "blobServices.json#/definitions/BlobService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns the list of metric definitions for BLOB service.": { - "$ref": "./examples/BlobService/ListMetricDefinitions.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_ListMetricDefinitions", - "description": "Returns the list of metric definitions for BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions for the BLOB service has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for BLOB service.": { - "$ref": "./examples/BlobService/ListMetrics.json" - } - }, - "tags": [ - "BlobServices" - ], - "operationId": "BlobServices_ListMetrics", - "description": "Returns a list of metrics for BLOB service.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "BlobServiceWritableSettings": { - "description": "Settings of BLOB service.", - "type": "object", - "properties": { - "blobSvcContainerGcInterval": { - "description": "The interval, in seconds, of container garbage collection.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "blobSvcShallowGcInterval": { - "description": "The interval ,in seconds, of shallow garbage collection.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "blobSvcStreamMapMinContainerOccupancyPercent": { - "description": "The minimal container occupancy percent for stream mapping.", - "type": "integer", - "format": "int32", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/WritableServiceSettings" - } - ] - }, - "BlobServiceSettings": { - "description": "Blob service settings.", - "type": "object", - "allOf": [ - { - "$ref": "blobServices.json#/definitions/BlobServiceWritableSettings" - } - ] - }, - "BlobServiceProperties": { - "description": "Blob service properties.", - "type": "object", - "properties": { - "settings": { - "x-ms-client-flatten": true, - "$ref": "blobServices.json#/definitions/BlobServiceSettings", - "description": "Blob service settings.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - }, - "BlobService": { - "description": "The BLOB service.", - "type": "object", - "properties": { - "properties": { - "description": "Blob service properties.", - "x-ms-client-flatten": true, - "$ref": "blobServices.json#/definitions/BlobServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the BLOB service.": { + "$ref": "./examples/BlobService/Get.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_Get", + "description": "Returns the BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The BLOB service has been returned.", + "schema": { + "$ref": "blobServices.json#/definitions/BlobService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns the list of metric definitions for BLOB service.": { + "$ref": "./examples/BlobService/ListMetricDefinitions.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_ListMetricDefinitions", + "description": "Returns the list of metric definitions for BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions for the BLOB service has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/blobservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for BLOB service.": { + "$ref": "./examples/BlobService/ListMetrics.json" + } + }, + "tags": [ + "BlobServices" + ], + "operationId": "BlobServices_ListMetrics", + "description": "Returns a list of metrics for BLOB service.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BlobServiceWritableSettings": { + "description": "Settings of BLOB service.", + "type": "object", + "properties": { + "blobSvcContainerGcInterval": { + "description": "The interval, in seconds, of container garbage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "blobSvcShallowGcInterval": { + "description": "The interval ,in seconds, of shallow garbage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "blobSvcStreamMapMinContainerOccupancyPercent": { + "description": "The minimal container occupancy percent for stream mapping.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/WritableServiceSettings" + } + ] + }, + "BlobServiceSettings": { + "description": "Blob service settings.", + "type": "object", + "allOf": [ + { + "$ref": "blobServices.json#/definitions/BlobServiceWritableSettings" + } + ] + }, + "BlobServiceProperties": { + "description": "Blob service properties.", + "type": "object", + "properties": { + "settings": { + "x-ms-client-flatten": true, + "$ref": "blobServices.json#/definitions/BlobServiceSettings", + "description": "Blob service settings.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + }, + "BlobService": { + "description": "The BLOB service.", + "type": "object", + "properties": { + "properties": { + "description": "Blob service properties.", + "x-ms-client-flatten": true, + "$ref": "blobServices.json#/definitions/BlobServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json index 59ba4701c518..5a7798e5c6fe 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json @@ -1,449 +1,449 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/operationresults/{operationId}": { - "post": { - "x-ms-examples": { - "Cancel a container migration job.": { - "$ref": "./examples/Containers/CancelMigration.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_CancelMigration", - "description": "Cancel a container migration job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Operation has been accepted and processed", - "schema": { - "$ref": "containers.json#/definitions/MigrationResult" - } - }, - "202": { - "description": "ACCEPTED - Operation has been accepted will be processed asynchronously", - "schema": { - "$ref": "containers.json#/definitions/MigrationResult" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "x-ms-examples": { - "Returns the status of a container migration job.": { - "$ref": "./examples/Containers/MigrationStatus.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_MigrationStatus", - "description": "Returns the status of a container migration job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Operation has been accepted and processed", - "schema": { - "$ref": "containers.json#/definitions/MigrationResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/containers": { - "get": { - "x-ms-examples": { - "Returns the list of containers which can be migrated in the specified share.": { - "$ref": "./examples/Containers/List.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_List", - "description": "Returns the list of containers which can be migrated in the specified share.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "containers.json#/parameters/MigrationIntentParameter" - }, - { - "$ref": "containers.json#/parameters/MaxCountParameter" - }, - { - "$ref": "containers.json#/parameters/StartIndexParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of containers has been returned.", - "schema": { - "$ref": "containers.json#/definitions/ContainerList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or share was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/destinationshares": { - "get": { - "x-ms-examples": { - "Returns a list of destination shares that the system considers as best candidates for migration.": { - "$ref": "./examples/Containers/ListDestinationShares.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_ListDestinationShares", - "description": "Returns a list of destination shares that the system considers as best candidates for migration.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of shares has been returned.", - "schema": { - "$ref": "shares.json#/definitions/ShareList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or share was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/migrate": { - "post": { - "x-ms-examples": { - "Starts a container migration job to migrate containers to the specified destination share.": { - "$ref": "./examples/Containers/Migrate.json" - } - }, - "tags": [ - "Containers" - ], - "operationId": "Containers_Migrate", - "description": "Starts a container migration job to migrate containers to the specified destination share.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "containers.json#/parameters/MigrationParameterParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Container has been migrated", - "schema": { - "$ref": "containers.json#/definitions/MigrationResult" - } - }, - "202": { - "description": "ACCEPTED -- Operation accepted and will be performed asynchronously", - "schema": { - "$ref": "containers.json#/definitions/MigrationResult" - } - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "Container": { - "description": "Container properties.", - "type": "object", - "properties": { - "sharename": { - "description": "The name of the share where the container locates.", - "type": "string", - "readOnly": true - }, - "accountname": { - "description": "The name of storage account where the container locates.", - "type": "string", - "readOnly": true - }, - "containername": { - "description": "Container name.", - "type": "string", - "readOnly": true - }, - "containerid": { - "description": "The container ID.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "accountid": { - "description": "The ID of the storage account.", - "type": "string", - "readOnly": true - }, - "usedBytesInPrimaryVolume": { - "description": "The used space, in bytes, of the container in the primary volume.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "containerState": { - "description": "The current state of the container.", - "type": "string", - "readOnly": true - } - } - }, - "ContainerList": { - "description": "List of containers.", - "type": "array", - "items": { - "$ref": "containers.json#/definitions/Container" - } - }, - "MigrationResult": { - "description": "The result of the container migration.", - "type": "object", - "properties": { - "jobId": { - "description": "The migration job ID.", - "type": "string", - "readOnly": true - }, - "sourceShareName": { - "description": "The name of the source storage share.", - "type": "string", - "readOnly": true - }, - "storageAccountName": { - "description": "The storage account name.", - "type": "string", - "readOnly": true - }, - "containerName": { - "description": "The name of the container to be migrated.", - "type": "string", - "readOnly": true - }, - "destinationShareName": { - "description": "The name of the destination storage share.", - "type": "string", - "readOnly": true - }, - "migrationStatus": { - "description": "The migration status.", - "$ref": "containers.json#/definitions/MigrationState", - "readOnly": true - }, - "subEntitiesCompleted": { - "description": "The number of entities which have been migrated.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "subEntitiesFailed": { - "description": "The number of entities which failed in migration.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "failureReason": { - "description": "The migration failure reason.", - "type": "string", - "readOnly": true - } - } - }, - "MigrationState": { - "type": "string", - "enum": [ - "Active", - "Paused", - "Deleted", - "Rollback", - "Complete", - "Canceled", - "Failed", - "All" - ], - "x-ms-enum": { - "name": "MigrationState", - "modelAsString": true - } - }, - "MigrationParameters": { - "description": "Parameters of container migration job.", - "type": "object", - "properties": { - "storageAccountName": { - "type": "string", - "description": "The name of the storage account where the container locates." - }, - "containerName": { - "type": "string", - "description": "The name of the container to be migrated." - }, - "destinationShareUncPath": { - "type": "string", - "description": "The UNC path of the destination share for migration." - } - }, - "required": [ - "storageAccountName", - "containerName", - "destinationShareUncPath" - ] - } - }, - "parameters": { - "MigrationIntentParameter": { - "description": "The container migration intent.", - "name": "Intent", - "in": "query", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "MaxCountParameter": { - "description": "The maximum number of containers.", - "name": "MaxCount", - "in": "query", - "type": "integer", - "format": "int32", - "required": false, - "x-ms-parameter-location": "method" - }, - "StartIndexParameter": { - "description": "The starting index the resource provider uses.", - "name": "StartIndex", - "in": "query", - "type": "integer", - "format": "int32", - "required": false, - "x-ms-parameter-location": "method" - }, - "MigrationParameterParameter": { - "description": "The parameters of container migration job.", - "name": "migrationParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "containers.json#/definitions/MigrationParameters" - }, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/operationresults/{operationId}": { + "post": { + "x-ms-examples": { + "Cancel a container migration job.": { + "$ref": "./examples/Containers/CancelMigration.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_CancelMigration", + "description": "Cancel a container migration job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation has been accepted and processed", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + }, + "202": { + "description": "ACCEPTED - Operation has been accepted will be processed asynchronously", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "x-ms-examples": { + "Returns the status of a container migration job.": { + "$ref": "./examples/Containers/MigrationStatus.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_MigrationStatus", + "description": "Returns the status of a container migration job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation has been accepted and processed", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/containers": { + "get": { + "x-ms-examples": { + "Returns the list of containers which can be migrated in the specified share.": { + "$ref": "./examples/Containers/List.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_List", + "description": "Returns the list of containers which can be migrated in the specified share.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "containers.json#/parameters/MigrationIntentParameter" + }, + { + "$ref": "containers.json#/parameters/MaxCountParameter" + }, + { + "$ref": "containers.json#/parameters/StartIndexParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of containers has been returned.", + "schema": { + "$ref": "containers.json#/definitions/ContainerList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or share was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/destinationshares": { + "get": { + "x-ms-examples": { + "Returns a list of destination shares that the system considers as best candidates for migration.": { + "$ref": "./examples/Containers/ListDestinationShares.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_ListDestinationShares", + "description": "Returns a list of destination shares that the system considers as best candidates for migration.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of shares has been returned.", + "schema": { + "$ref": "shares.json#/definitions/ShareList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or share was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/migrate": { + "post": { + "x-ms-examples": { + "Starts a container migration job to migrate containers to the specified destination share.": { + "$ref": "./examples/Containers/Migrate.json" + } + }, + "tags": [ + "Containers" + ], + "operationId": "Containers_Migrate", + "description": "Starts a container migration job to migrate containers to the specified destination share.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "containers.json#/parameters/MigrationParameterParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Container has been migrated", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + }, + "202": { + "description": "ACCEPTED -- Operation accepted and will be performed asynchronously", + "schema": { + "$ref": "containers.json#/definitions/MigrationResult" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Container": { + "description": "Container properties.", + "type": "object", + "properties": { + "sharename": { + "description": "The name of the share where the container locates.", + "type": "string", + "readOnly": true + }, + "accountname": { + "description": "The name of storage account where the container locates.", + "type": "string", + "readOnly": true + }, + "containername": { + "description": "Container name.", + "type": "string", + "readOnly": true + }, + "containerid": { + "description": "The container ID.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "accountid": { + "description": "The ID of the storage account.", + "type": "string", + "readOnly": true + }, + "usedBytesInPrimaryVolume": { + "description": "The used space, in bytes, of the container in the primary volume.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "containerState": { + "description": "The current state of the container.", + "type": "string", + "readOnly": true + } + } + }, + "ContainerList": { + "description": "List of containers.", + "type": "array", + "items": { + "$ref": "containers.json#/definitions/Container" + } + }, + "MigrationResult": { + "description": "The result of the container migration.", + "type": "object", + "properties": { + "jobId": { + "description": "The migration job ID.", + "type": "string", + "readOnly": true + }, + "sourceShareName": { + "description": "The name of the source storage share.", + "type": "string", + "readOnly": true + }, + "storageAccountName": { + "description": "The storage account name.", + "type": "string", + "readOnly": true + }, + "containerName": { + "description": "The name of the container to be migrated.", + "type": "string", + "readOnly": true + }, + "destinationShareName": { + "description": "The name of the destination storage share.", + "type": "string", + "readOnly": true + }, + "migrationStatus": { + "description": "The migration status.", + "$ref": "containers.json#/definitions/MigrationState", + "readOnly": true + }, + "subEntitiesCompleted": { + "description": "The number of entities which have been migrated.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "subEntitiesFailed": { + "description": "The number of entities which failed in migration.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "failureReason": { + "description": "The migration failure reason.", + "type": "string", + "readOnly": true + } + } + }, + "MigrationState": { + "type": "string", + "enum": [ + "Active", + "Paused", + "Deleted", + "Rollback", + "Complete", + "Canceled", + "Failed", + "All" + ], + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationParameters": { + "description": "Parameters of container migration job.", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the storage account where the container locates." + }, + "containerName": { + "type": "string", + "description": "The name of the container to be migrated." + }, + "destinationShareUncPath": { + "type": "string", + "description": "The UNC path of the destination share for migration." + } + }, + "required": [ + "storageAccountName", + "containerName", + "destinationShareUncPath" + ] + } + }, + "parameters": { + "MigrationIntentParameter": { + "description": "The container migration intent.", + "name": "Intent", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxCountParameter": { + "description": "The maximum number of containers.", + "name": "MaxCount", + "in": "query", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + }, + "StartIndexParameter": { + "description": "The starting index the resource provider uses.", + "name": "StartIndex", + "in": "query", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + }, + "MigrationParameterParameter": { + "description": "The parameters of container migration job.", + "name": "migrationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "containers.json#/definitions/MigrationParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json index 7159cb373383..afcb3653442c 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json @@ -1,702 +1,702 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}": { - "put": { - "x-ms-examples": { - "Create a new storage farm.": { - "$ref": "./examples/Farms/Create.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Create a new storage farm.", - "operationId": "Farms_Create", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "description": "Parameters used to create a farm", - "name": "farmObject", - "in": "body", - "required": true, - "schema": { - "$ref": "farms.json#/definitions/FarmCreationProperties" - } - } - ], - "responses": { - "200": { - "description": "OK -- The new storage farm has been created.", - "schema": { - "$ref": "farms.json#/definitions/Farm" - } - } - } - }, - "get": { - "x-ms-examples": { - "Returns the Storage properties and settings for a specified storage farm.": { - "$ref": "./examples/Farms/Get.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns the Storage properties and settings for a specified storage farm.", - "operationId": "Farms_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The farm has been returned.", - "schema": { - "$ref": "farms.json#/definitions/Farm" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - }, - "patch": { - "x-ms-examples": { - "Update an existing storage farm.": { - "$ref": "./examples/Farms/Update.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Update an existing storage farm.", - "operationId": "Farms_Update", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "description": "Farm to update.", - "name": "farmObject", - "in": "body", - "required": true, - "schema": { - "$ref": "farms.json#/definitions/Farm" - } - } - ], - "responses": { - "200": { - "description": "OK -- The properties and settings of storage farm have been updated.", - "schema": { - "$ref": "farms.json#/definitions/Farm" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for a storage farm.": { - "$ref": "./examples/Farms/ListMetricDefinitions.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of metric definitions for a storage farm.", - "operationId": "Farms_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of storage farm metrics.": { - "$ref": "./examples/Farms/ListMetrics.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of storage farm metrics.", - "operationId": "Farms_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms": { - "get": { - "x-ms-examples": { - "Returns a list of all storage farms.": { - "$ref": "./examples/Farms/List.json" - } - }, - "tags": [ - "Farms" - ], - "description": "Returns a list of all storage farms.", - "operationId": "Farms_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage farms has been returned.", - "schema": { - "$ref": "farms.json#/definitions/FarmList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/ondemandgc": { - "post": { - "x-ms-examples": { - "Start garbage collection on deleted storage objects.": { - "$ref": "./examples/Farms/StartGarbageCollection.json" - } - }, - "tags": [ - "Farms" - ], - "operationId": "Farms_StartGarbageCollection", - "description": "Start garbage collection on deleted storage objects.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Garbage collection has completed." - }, - "202": { - "description": "ACCEPTED -- Garbage collection has started." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/operationresults/{operationId}": { - "get": { - "x-ms-examples": { - "Returns the state of the garbage collection job.": { - "$ref": "./examples/Farms/GetGarbageCollectionState.json" - } - }, - "tags": [ - "GC" - ], - "operationId": "Farms_GetGarbageCollectionState", - "description": "Returns the state of the garbage collection job.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/OperationIdParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The state of garbage collection has been returned.", - "schema": { - "type": "string" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm or garbage collection job can not be found." - } - } - } - } - }, - "definitions": { - "FarmList": { - "description": "Pageable list of storage farms.", - "type": "object", - "properties": { - "value": { - "description": "List of storage farms.", - "type": "array", - "items": { - "$ref": "farms.json#/definitions/Farm" - } - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "FarmCreationProperties": { - "description": "Storage farm properties.", - "type": "object", - "properties": { - "properties": { - "description": "Storage farm properties.", - "x-ms-client-flatten": true, - "$ref": "farms.json#/definitions/SettingAccessString" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "Farm": { - "description": "Storage farm.", - "type": "object", - "properties": { - "properties": { - "description": "Storage farm properties.", - "x-ms-client-flatten": true, - "$ref": "farms.json#/definitions/FarmProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "FarmSettings": { - "description": "Storage farm settings.", - "type": "object", - "properties": { - "settingsPollingIntervalInSecond": { - "description": "The polling interval (in second).", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "retentionPeriodForDeletedStorageAccountsInDays": { - "description": "The retention period (in days) for deleted storage account.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "hostStyleHttpPort": { - "description": "Host style HTTP port.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "hostStyleHttpsPort": { - "description": "Host style HTTPs port.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "corsAllowedOriginsList": { - "description": "The list of allowed origins.", - "type": "string", - "readOnly": true - }, - "dataCenterUriHostSuffixes": { - "description": "The suffixes of URI of hosts in data center.", - "type": "string", - "readOnly": true - }, - "bandwidthThrottleIsEnabled": { - "description": "Switch of bandwidth throttle enablement.", - "type": "boolean", - "readOnly": true - }, - "usageCollectionIntervalInSeconds": { - "description": "Interval (in seconds) of storage usage collection.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "feedbackRefreshIntervalInSeconds": { - "description": "Interval (in seconds) of feedback refresh.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "numberOfAccountsToSync": { - "description": "Number of accounts to sync.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "defaultThrottleProbabilityDecayIntervalInSeconds": { - "description": "Interval (in seconds) of default throttle probability decay.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "gracePeriodForFullThrottlingInRefreshIntervals": { - "description": "Grace period for full throttling in refresh intervals.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "gracePeriodMaxThrottleProbability": { - "description": "Maximum probability of throttle in grace period.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallRequestThresholdInTps": { - "description": "Overall request threshold (in TPS).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultRequestThresholdInTps": { - "description": "Default request threshold (in TPS).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumRequestThresholdInTps": { - "description": "Minimum request threshold (in TPS).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForTps": { - "description": "Tolerance factor for TPS.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallIngressThresholdInGbps": { - "description": "Overall ingress threshold (in Gbps)", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultIngressThresholdInGbps": { - "description": "Default ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumIngressThresholdInGbps": { - "description": "Minimum ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForIngress": { - "description": "Tolerance factor for ingress.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallIntranetIngressThresholdInGbps": { - "description": "Overall Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultIntranetIngressThresholdInGbps": { - "description": "Default Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumIntranetIngressThresholdInGbps": { - "description": "Minimum Intranet ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForIntranetIngress": { - "description": "Tolerance factor for Intranet ingress.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallEgressThresholdInGbps": { - "description": "Overall egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultEgressThresholdInGbps": { - "description": "Default egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumEgressThresholdInGbps": { - "description": "Minimum egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForEgress": { - "description": "Tolerance factor for egress.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallIntranetEgressThresholdInGbps": { - "description": "Overall Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultIntranetEgressThresholdInGbps": { - "description": "Default Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumIntranetEgressThresholdInGbps": { - "description": "Minimum Intranet egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForIntranetEgress": { - "description": "Tolerance factor for Intranet egress.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallTotalIngressThresholdInGbps": { - "description": "Overall total ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultTotalIngressThresholdInGbps": { - "description": "Default total ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumTotalIngressThresholdInGbps": { - "description": "Minimum total ingress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForTotalIngress": { - "description": "Tolerance factor for total ingress.", - "type": "number", - "format": "float", - "readOnly": true - }, - "overallTotalEgressThresholdInGbps": { - "description": "Overall total egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "defaultTotalEgressThresholdInGbps": { - "description": "Default total egress threshold (in Gbps).", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimumTotalEgressThresholdInGbps": { - "description": "Minimum total egress threshold (in Gbp", - "type": "number", - "format": "float", - "readOnly": true - }, - "toleranceFactorForTotalEgress": { - "description": "Tolerance factor for total egress.", - "type": "number", - "format": "float", - "readOnly": true - } - } - }, - "FarmProperties": { - "description": "The properties of storage farm.", - "type": "object", - "properties": { - "farmId": { - "description": "Farm identifier.", - "type": "string", - "readOnly": true - }, - "version": { - "description": "Resource version.", - "type": "string", - "readOnly": true - }, - "settingsStore": { - "description": "The settings of storage farm.", - "type": "string", - "readOnly": true - }, - "settings": { - "description": "The properties of storage farm.", - "x-ms-client-flatten": true, - "$ref": "farms.json#/definitions/FarmSettings", - "readOnly": true - } - } - }, - "SettingAccessString": { - "description": "Setting access string.", - "type": "object", - "properties": { - "settingAccessString": { - "description": "Setting access string.", - "type": "string" - } - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}": { + "put": { + "x-ms-examples": { + "Create a new storage farm.": { + "$ref": "./examples/Farms/Create.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Create a new storage farm.", + "operationId": "Farms_Create", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "description": "Parameters used to create a farm", + "name": "farmObject", + "in": "body", + "required": true, + "schema": { + "$ref": "farms.json#/definitions/FarmCreationProperties" + } + } + ], + "responses": { + "200": { + "description": "OK -- The new storage farm has been created.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + } + }, + "get": { + "x-ms-examples": { + "Returns the Storage properties and settings for a specified storage farm.": { + "$ref": "./examples/Farms/Get.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns the Storage properties and settings for a specified storage farm.", + "operationId": "Farms_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The farm has been returned.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + }, + "patch": { + "x-ms-examples": { + "Update an existing storage farm.": { + "$ref": "./examples/Farms/Update.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Update an existing storage farm.", + "operationId": "Farms_Update", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "description": "Farm to update.", + "name": "farmObject", + "in": "body", + "required": true, + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + ], + "responses": { + "200": { + "description": "OK -- The properties and settings of storage farm have been updated.", + "schema": { + "$ref": "farms.json#/definitions/Farm" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for a storage farm.": { + "$ref": "./examples/Farms/ListMetricDefinitions.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of metric definitions for a storage farm.", + "operationId": "Farms_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of storage farm metrics.": { + "$ref": "./examples/Farms/ListMetrics.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of storage farm metrics.", + "operationId": "Farms_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms": { + "get": { + "x-ms-examples": { + "Returns a list of all storage farms.": { + "$ref": "./examples/Farms/List.json" + } + }, + "tags": [ + "Farms" + ], + "description": "Returns a list of all storage farms.", + "operationId": "Farms_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage farms has been returned.", + "schema": { + "$ref": "farms.json#/definitions/FarmList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/ondemandgc": { + "post": { + "x-ms-examples": { + "Start garbage collection on deleted storage objects.": { + "$ref": "./examples/Farms/StartGarbageCollection.json" + } + }, + "tags": [ + "Farms" + ], + "operationId": "Farms_StartGarbageCollection", + "description": "Start garbage collection on deleted storage objects.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Garbage collection has completed." + }, + "202": { + "description": "ACCEPTED -- Garbage collection has started." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/operationresults/{operationId}": { + "get": { + "x-ms-examples": { + "Returns the state of the garbage collection job.": { + "$ref": "./examples/Farms/GetGarbageCollectionState.json" + } + }, + "tags": [ + "GC" + ], + "operationId": "Farms_GetGarbageCollectionState", + "description": "Returns the state of the garbage collection job.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The state of garbage collection has been returned.", + "schema": { + "type": "string" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm or garbage collection job can not be found." + } + } + } + } + }, + "definitions": { + "FarmList": { + "description": "Pageable list of storage farms.", + "type": "object", + "properties": { + "value": { + "description": "List of storage farms.", + "type": "array", + "items": { + "$ref": "farms.json#/definitions/Farm" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "FarmCreationProperties": { + "description": "Storage farm properties.", + "type": "object", + "properties": { + "properties": { + "description": "Storage farm properties.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/SettingAccessString" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "Farm": { + "description": "Storage farm.", + "type": "object", + "properties": { + "properties": { + "description": "Storage farm properties.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/FarmProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "FarmSettings": { + "description": "Storage farm settings.", + "type": "object", + "properties": { + "settingsPollingIntervalInSecond": { + "description": "The polling interval (in second).", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "retentionPeriodForDeletedStorageAccountsInDays": { + "description": "The retention period (in days) for deleted storage account.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "hostStyleHttpPort": { + "description": "Host style HTTP port.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "hostStyleHttpsPort": { + "description": "Host style HTTPs port.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "corsAllowedOriginsList": { + "description": "The list of allowed origins.", + "type": "string", + "readOnly": true + }, + "dataCenterUriHostSuffixes": { + "description": "The suffixes of URI of hosts in data center.", + "type": "string", + "readOnly": true + }, + "bandwidthThrottleIsEnabled": { + "description": "Switch of bandwidth throttle enablement.", + "type": "boolean", + "readOnly": true + }, + "usageCollectionIntervalInSeconds": { + "description": "Interval (in seconds) of storage usage collection.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "feedbackRefreshIntervalInSeconds": { + "description": "Interval (in seconds) of feedback refresh.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "numberOfAccountsToSync": { + "description": "Number of accounts to sync.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "defaultThrottleProbabilityDecayIntervalInSeconds": { + "description": "Interval (in seconds) of default throttle probability decay.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "gracePeriodForFullThrottlingInRefreshIntervals": { + "description": "Grace period for full throttling in refresh intervals.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "gracePeriodMaxThrottleProbability": { + "description": "Maximum probability of throttle in grace period.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallRequestThresholdInTps": { + "description": "Overall request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultRequestThresholdInTps": { + "description": "Default request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumRequestThresholdInTps": { + "description": "Minimum request threshold (in TPS).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTps": { + "description": "Tolerance factor for TPS.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIngressThresholdInGbps": { + "description": "Overall ingress threshold (in Gbps)", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIngressThresholdInGbps": { + "description": "Default ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIngressThresholdInGbps": { + "description": "Minimum ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIngress": { + "description": "Tolerance factor for ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIntranetIngressThresholdInGbps": { + "description": "Overall Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIntranetIngressThresholdInGbps": { + "description": "Default Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIntranetIngressThresholdInGbps": { + "description": "Minimum Intranet ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIntranetIngress": { + "description": "Tolerance factor for Intranet ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallEgressThresholdInGbps": { + "description": "Overall egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultEgressThresholdInGbps": { + "description": "Default egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumEgressThresholdInGbps": { + "description": "Minimum egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForEgress": { + "description": "Tolerance factor for egress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallIntranetEgressThresholdInGbps": { + "description": "Overall Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultIntranetEgressThresholdInGbps": { + "description": "Default Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumIntranetEgressThresholdInGbps": { + "description": "Minimum Intranet egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForIntranetEgress": { + "description": "Tolerance factor for Intranet egress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallTotalIngressThresholdInGbps": { + "description": "Overall total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultTotalIngressThresholdInGbps": { + "description": "Default total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumTotalIngressThresholdInGbps": { + "description": "Minimum total ingress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTotalIngress": { + "description": "Tolerance factor for total ingress.", + "type": "number", + "format": "float", + "readOnly": true + }, + "overallTotalEgressThresholdInGbps": { + "description": "Overall total egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "defaultTotalEgressThresholdInGbps": { + "description": "Default total egress threshold (in Gbps).", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimumTotalEgressThresholdInGbps": { + "description": "Minimum total egress threshold (in Gbp", + "type": "number", + "format": "float", + "readOnly": true + }, + "toleranceFactorForTotalEgress": { + "description": "Tolerance factor for total egress.", + "type": "number", + "format": "float", + "readOnly": true + } + } + }, + "FarmProperties": { + "description": "The properties of storage farm.", + "type": "object", + "properties": { + "farmId": { + "description": "Farm identifier.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Resource version.", + "type": "string", + "readOnly": true + }, + "settingsStore": { + "description": "The settings of storage farm.", + "type": "string", + "readOnly": true + }, + "settings": { + "description": "The properties of storage farm.", + "x-ms-client-flatten": true, + "$ref": "farms.json#/definitions/FarmSettings", + "readOnly": true + } + } + }, + "SettingAccessString": { + "description": "Setting access string.", + "type": "object", + "properties": { + "settingAccessString": { + "description": "Setting access string.", + "type": "string" + } + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json index 63faf4913473..bd7b428b1269 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json @@ -1,207 +1,207 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the queue service.": { - "$ref": "./examples/QueueService/Get.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns the queue service.", - "operationId": "QueueServices_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Queue service has been returned.", - "schema": { - "$ref": "queueServices.json#/definitions/QueueService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for queue service.": { - "$ref": "./examples/QueueService/ListMetricDefinitions.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns a list of metric definitions for queue service.", - "operationId": "QueueServices_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for the queue service.": { - "$ref": "./examples/QueueService/ListMetrics.json" - } - }, - "tags": [ - "QueueServices" - ], - "description": "Returns a list of metrics for the queue service.", - "operationId": "QueueServices_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "QueueServiceProperties": { - "description": "Queue service properties.", - "type": "object", - "properties": { - "settings": { - "description": "Queue service settings.", - "x-ms-client-flatten": true, - "$ref": "storage.json#/definitions/WritableServiceSettings", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - }, - "QueueService": { - "description": "Queue service.", - "type": "object", - "properties": { - "properties": { - "description": "Queue service properties.", - "x-ms-client-flatten": true, - "$ref": "queueServices.json#/definitions/QueueServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the queue service.": { + "$ref": "./examples/QueueService/Get.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns the queue service.", + "operationId": "QueueServices_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Queue service has been returned.", + "schema": { + "$ref": "queueServices.json#/definitions/QueueService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for queue service.": { + "$ref": "./examples/QueueService/ListMetricDefinitions.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns a list of metric definitions for queue service.", + "operationId": "QueueServices_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/queueservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for the queue service.": { + "$ref": "./examples/QueueService/ListMetrics.json" + } + }, + "tags": [ + "QueueServices" + ], + "description": "Returns a list of metrics for the queue service.", + "operationId": "QueueServices_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "QueueServiceProperties": { + "description": "Queue service properties.", + "type": "object", + "properties": { + "settings": { + "description": "Queue service settings.", + "x-ms-client-flatten": true, + "$ref": "storage.json#/definitions/WritableServiceSettings", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + }, + "QueueService": { + "description": "Queue service.", + "type": "object", + "properties": { + "properties": { + "description": "Queue service properties.", + "x-ms-client-flatten": true, + "$ref": "queueServices.json#/definitions/QueueServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json index 96563f8296ad..c26c1fec6db7 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json @@ -1,263 +1,263 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas/{quotaName}": { - "put": { - "x-ms-examples": { - "Create or update an existing storage quota.": { - "$ref": "./examples/Quotas/CreateOrUpdate.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Create or update an existing storage quota.", - "operationId": "StorageQuotas_CreateOrUpdate", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "quotas.json#/parameters/QuotaNameParameter" - }, - { - "$ref": "quotas.json#/parameters/StorgeQuotaParameters" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been created or updated.", - "schema": { - "$ref": "quotas.json#/definitions/StorageQuota" - } - }, - "404": { - "description": "NOT FOUND -- The location or quota was not found." - } - } - }, - "delete": { - "x-ms-examples": { - "Delete an existing storage quota.": { - "$ref": "./examples/Quotas/Delete.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Delete an existing quota", - "operationId": "StorageQuotas_Delete", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "quotas.json#/parameters/QuotaNameParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been deleted." - }, - "404": { - "description": "NOT FOUND -- The location or storage quota cannot be found." - } - } - }, - "get": { - "x-ms-examples": { - "Returns the specified storage quota.": { - "$ref": "./examples/Quotas/Get.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Returns the specified storage quota.", - "operationId": "StorageQuotas_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "quotas.json#/parameters/QuotaNameParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage quota has been returned.", - "schema": { - "$ref": "quotas.json#/definitions/StorageQuota" - } - }, - "404": { - "description": "NOT FOUND -- The location or storage quota cannot be found." - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas": { - "get": { - "x-ms-examples": { - "Returns a list of storage quotas at the given location.": { - "$ref": "./examples/Quotas/List.json" - } - }, - "tags": [ - "StorageQuotas" - ], - "description": "Returns a list of storage quotas at the given location.", - "operationId": "StorageQuotas_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/LocationParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage quotas has been returned.", - "schema": { - "$ref": "quotas.json#/definitions/StorageQuotaList" - } - }, - "404": { - "description": "OK -- The location does not exist." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "StorageQuota": { - "description": "Storage quota.", - "type": "object", - "properties": { - "properties": { - "description": "Storage quota properties.", - "x-ms-client-flatten": true, - "$ref": "quotas.json#/definitions/StorageQuotaProperties" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "StorageQuotaProperties": { - "description": "Storage quota properties.", - "type": "object", - "properties": { - "numberOfStorageAccounts": { - "description": "Total number of storage accounts.", - "type": "integer", - "format": "int32", - "default": 20 - }, - "capacityInGb": { - "description": "Maxium capacity (GB).", - "type": "integer", - "format": "int32", - "default": 500 - } - } - }, - "StorageQuotaList": { - "description": "Pageable list of storage quotas.", - "type": "object", - "properties": { - "value": { - "description": "List of storage quotas.", - "type": "array", - "items": { - "$ref": "quotas.json#/definitions/StorageQuota" - } - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string" - } - } - } - }, - "parameters": { - "QuotaNameParameter": { - "description": "The name of the storage quota.", - "name": "quotaName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "StorgeQuotaParameters": { - "description": "The properties of quota being created or updated.", - "name": "quotaObject", - "in": "body", - "required": true, - "schema": { - "$ref": "quotas.json#/definitions/StorageQuota" - }, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas/{quotaName}": { + "put": { + "x-ms-examples": { + "Create or update an existing storage quota.": { + "$ref": "./examples/Quotas/CreateOrUpdate.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Create or update an existing storage quota.", + "operationId": "StorageQuotas_CreateOrUpdate", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + }, + { + "$ref": "quotas.json#/parameters/StorgeQuotaParameters" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been created or updated.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "404": { + "description": "NOT FOUND -- The location or quota was not found." + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an existing storage quota.": { + "$ref": "./examples/Quotas/Delete.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Delete an existing quota", + "operationId": "StorageQuotas_Delete", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been deleted." + }, + "404": { + "description": "NOT FOUND -- The location or storage quota cannot be found." + } + } + }, + "get": { + "x-ms-examples": { + "Returns the specified storage quota.": { + "$ref": "./examples/Quotas/Get.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Returns the specified storage quota.", + "operationId": "StorageQuotas_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "quotas.json#/parameters/QuotaNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage quota has been returned.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "404": { + "description": "NOT FOUND -- The location or storage quota cannot be found." + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage.Admin/locations/{location}/quotas": { + "get": { + "x-ms-examples": { + "Returns a list of storage quotas at the given location.": { + "$ref": "./examples/Quotas/List.json" + } + }, + "tags": [ + "StorageQuotas" + ], + "description": "Returns a list of storage quotas at the given location.", + "operationId": "StorageQuotas_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/LocationParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage quotas has been returned.", + "schema": { + "$ref": "quotas.json#/definitions/StorageQuotaList" + } + }, + "404": { + "description": "OK -- The location does not exist." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "StorageQuota": { + "description": "Storage quota.", + "type": "object", + "properties": { + "properties": { + "description": "Storage quota properties.", + "x-ms-client-flatten": true, + "$ref": "quotas.json#/definitions/StorageQuotaProperties" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "StorageQuotaProperties": { + "description": "Storage quota properties.", + "type": "object", + "properties": { + "numberOfStorageAccounts": { + "description": "Total number of storage accounts.", + "type": "integer", + "format": "int32", + "default": 20 + }, + "capacityInGb": { + "description": "Maxium capacity (GB).", + "type": "integer", + "format": "int32", + "default": 500 + } + } + }, + "StorageQuotaList": { + "description": "Pageable list of storage quotas.", + "type": "object", + "properties": { + "value": { + "description": "List of storage quotas.", + "type": "array", + "items": { + "$ref": "quotas.json#/definitions/StorageQuota" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "QuotaNameParameter": { + "description": "The name of the storage quota.", + "name": "quotaName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "StorgeQuotaParameters": { + "description": "The properties of quota being created or updated.", + "name": "quotaObject", + "in": "body", + "required": true, + "schema": { + "$ref": "quotas.json#/definitions/StorageQuota" + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json index c116c0201495..146c5992d2dd 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json @@ -1,278 +1,278 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares": { - "get": { - "x-ms-examples": { - "Returns a list of storage shares.": { - "$ref": "./examples/Shares/List.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of storage shares.", - "operationId": "Shares_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage shares has been returned.", - "schema": { - "$ref": "shares.json#/definitions/ShareList" - } - }, - "404": { - "description": "NOT FOUND -- The farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for a storage share.": { - "$ref": "./examples/Shares/ListMetrics.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of metrics for a storage share.", - "operationId": "Shares_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The farm or share cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for a storage share.": { - "$ref": "./examples/Shares/ListMetricDefinitions.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a list of metric definitions for a storage share.", - "operationId": "Shares_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The farm cannot be found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}": { - "get": { - "x-ms-examples": { - "Returns a storage share.": { - "$ref": "./examples/Shares/Get.json" - } - }, - "tags": [ - "Shares" - ], - "description": "Returns a storage share.", - "operationId": "Shares_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ShareNameParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage share has been returned.", - "schema": { - "$ref": "shares.json#/definitions/Share" - } - }, - "404": { - "description": "NOT FOUND -- The farm or storage share cannot be found." - } - } - } - } - }, - "definitions": { - "Share": { - "description": "Storage share.", - "type": "object", - "properties": { - "properties": { - "description": "Storage share properties.", - "x-ms-client-flatten": true, - "$ref": "shares.json#/definitions/ShareProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "ShareList": { - "description": "List of storage shares.", - "type": "array", - "items": { - "$ref": "shares.json#/definitions/Share" - } - }, - "ShareProperties": { - "description": "Storage share properties.", - "type": "object", - "properties": { - "shareName": { - "description": "The name of the storage share.", - "type": "string", - "readOnly": true - }, - "uncPath": { - "description": "The UNC path to the storage share.", - "type": "string", - "readOnly": true - }, - "totalCapacity": { - "description": "The total capacity of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "usedCapacity": { - "description": "The used capacity of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "freeCapacity": { - "description": "The free space of the storage share in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "healthStatus": { - "description": "The health status of the storage share.", - "$ref": "storage.json#/definitions/HealthStatus", - "readOnly": true - } - } - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares": { + "get": { + "x-ms-examples": { + "Returns a list of storage shares.": { + "$ref": "./examples/Shares/List.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of storage shares.", + "operationId": "Shares_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage shares has been returned.", + "schema": { + "$ref": "shares.json#/definitions/ShareList" + } + }, + "404": { + "description": "NOT FOUND -- The farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for a storage share.": { + "$ref": "./examples/Shares/ListMetrics.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of metrics for a storage share.", + "operationId": "Shares_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The farm or share cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for a storage share.": { + "$ref": "./examples/Shares/ListMetricDefinitions.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a list of metric definitions for a storage share.", + "operationId": "Shares_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The farm cannot be found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/shares/{shareName}": { + "get": { + "x-ms-examples": { + "Returns a storage share.": { + "$ref": "./examples/Shares/Get.json" + } + }, + "tags": [ + "Shares" + ], + "description": "Returns a storage share.", + "operationId": "Shares_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ShareNameParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage share has been returned.", + "schema": { + "$ref": "shares.json#/definitions/Share" + } + }, + "404": { + "description": "NOT FOUND -- The farm or storage share cannot be found." + } + } + } + } + }, + "definitions": { + "Share": { + "description": "Storage share.", + "type": "object", + "properties": { + "properties": { + "description": "Storage share properties.", + "x-ms-client-flatten": true, + "$ref": "shares.json#/definitions/ShareProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "ShareList": { + "description": "List of storage shares.", + "type": "array", + "items": { + "$ref": "shares.json#/definitions/Share" + } + }, + "ShareProperties": { + "description": "Storage share properties.", + "type": "object", + "properties": { + "shareName": { + "description": "The name of the storage share.", + "type": "string", + "readOnly": true + }, + "uncPath": { + "description": "The UNC path to the storage share.", + "type": "string", + "readOnly": true + }, + "totalCapacity": { + "description": "The total capacity of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "usedCapacity": { + "description": "The used capacity of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "freeCapacity": { + "description": "The free space of the storage share in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "healthStatus": { + "description": "The health status of the storage share.", + "$ref": "storage.json#/definitions/HealthStatus", + "readOnly": true + } + } + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json index 374c28032326..699a16bc9c6c 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json @@ -1,575 +1,575 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Storage.Admin/operations": { - "get": { - "x-ms-examples": { - "Get the list of support rest operations.": { - "$ref": "./examples/Operations/List.json" - } - }, - "description": "Get the list of support rest operations.", - "tags": [ - "Commerce" - ], - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of operations has been returned.", - "schema": { - "$ref": "storage.json#/definitions/OperationList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "WritableSettings": { - "description": "Storage service settings.", - "type": "object", - "properties": { - "frontEndCallbackThreadsCount": { - "description": "Front end callback threads count.", - "type": "integer", - "format": "int32" - }, - "frontEndCpuBasedKeepAliveThrottlingEnabled": { - "description": "Switch of front end CPU based keep-alive throttling.", - "type": "boolean" - }, - "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": { - "description": "Threshold (% percentage) of front end CPU based keep-alive throttling.", - "type": "number", - "format": "float" - }, - "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": { - "description": "Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.", - "type": "number", - "format": "float" - }, - "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": { - "description": "Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.", - "type": "integer", - "format": "int32" - }, - "frontEndMemoryThrottlingEnabled": { - "description": "Switch of front end memory throttling.", - "type": "boolean" - }, - "frontEndMaxMillisecondsBetweenMemorySamples": { - "description": "Maxium interval (in millisecond) between memory samples of front end.", - "type": "integer", - "format": "int32" - }, - "frontEndMemoryThrottleThresholdSettings": { - "description": "Front end memory throttle threshold settings.", - "type": "string" - }, - "frontEndMinThreadPoolThreads": { - "description": "Front end minimum number of threads in thread pool.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": { - "description": "Threshold of front end thread pool based keep-alive IO completion.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": { - "description": "Threshold of front end thread pool based keep-alive worker thread.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": { - "description": "Monitor interval (in seconds) of front end thread pool based keep-alive monitor.", - "type": "integer", - "format": "int32" - }, - "frontEndThreadPoolBasedKeepAlivePercentage": { - "description": "Percentage (%) of front end thread pool based keep-alive.", - "type": "number", - "format": "float" - }, - "frontEndUseSlaTimeInAvailability": { - "description": "Switch of whether front end uses SLA time in availability.", - "type": "boolean" - } - } - }, - "WritableServiceSettings": { - "description": "Settings of storage services.", - "type": "object", - "properties": { - "frontEndHttpsListenPort": { - "description": "The HTTPs port of the storage service front end.", - "type": "integer", - "format": "int32" - }, - "frontEndHttpListenPort": { - "description": "The HTTP port of the storage service front end.", - "type": "integer", - "format": "int32" - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/WritableSettings" - } - ] - }, - "LocalizableString": { - "description": "Localizable string.", - "type": "object", - "properties": { - "value": { - "description": "Value of the string.", - "type": "string" - }, - "localizedValue": { - "description": "Localized value of the string.", - "type": "string" - } - } - }, - "MetricAvailability": { - "description": "Metric availability.", - "type": "object", - "properties": { - "timeGrain": { - "description": "Time grain.", - "type": "string" - }, - "retention": { - "description": "Retention of metric.", - "type": "string" - } - } - }, - "AggregateType": { - "description": "Aggregate type.", - "readOnly": true, - "type": "string", - "enum": [ - "None", - "Average", - "Total", - "Minimum", - "Maximum", - "Last" - ], - "x-ms-enum": { - "name": "AggregateType", - "modelAsString": true - } - }, - "MetricUnit": { - "description": "Metric unit.", - "type": "string", - "enum": [ - "Count", - "Bytes", - "Seconds", - "CountPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "MetricUnit", - "modelAsString": true - } - }, - "MetricDefinition": { - "description": "Metric definition.", - "type": "object", - "properties": { - "name": { - "description": "Metric name.", - "$ref": "storage.json#/definitions/LocalizableString", - "readOnly": true - }, - "unit": { - "description": "Metric unit.", - "$ref": "storage.json#/definitions/MetricUnit", - "readOnly": true - }, - "primaryAggregationType": { - "description": "Aggregation type of metric.", - "$ref": "storage.json#/definitions/AggregateType", - "readOnly": true - }, - "metricAvailabilities": { - "description": "Metric availabilities.", - "type": "array", - "items": { - "$ref": "storage.json#/definitions/MetricAvailability" - }, - "readOnly": true - } - } - }, - "Metric": { - "description": "Metric information.", - "type": "object", - "properties": { - "name": { - "description": "Metric Name.", - "$ref": "storage.json#/definitions/LocalizableString", - "readOnly": true - }, - "metricUnit": { - "description": "Metric Unit.", - "$ref": "storage.json#/definitions/MetricUnit", - "readOnly": true - }, - "timeGrain": { - "description": "Metric time grain.", - "type": "string", - "readOnly": true - }, - "startTime": { - "description": "Metric start time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "endTime": { - "description": "Metric end time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "metricValues": { - "description": "List of metric values.", - "type": "array", - "items": { - "$ref": "storage.json#/definitions/MetricValue" - }, - "readOnly": true - } - } - }, - "MetricDefinitionList": { - "description": "Pageable list of metric definitions.", - "type": "object", - "properties": { - "value": { - "description": "List of metric definitions.", - "type": "array", - "items": { - "$ref": "storage.json#/definitions/MetricDefinition" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "MetricList": { - "description": "Pageable list of metrics.", - "type": "object", - "properties": { - "value": { - "description": "List of metrics.", - "type": "array", - "items": { - "$ref": "storage.json#/definitions/Metric" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - }, - "MetricValue": { - "description": "Metric value.", - "properties": { - "timeStamp": { - "description": "Timestamp of metric value.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "average": { - "description": "Average value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "minimum": { - "description": "Minimum value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "maximum": { - "description": "Maximum value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "total": { - "description": "Total value of metric.", - "type": "number", - "format": "float", - "readOnly": true - }, - "count": { - "description": "Count of metric values.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "properties": { - "description": "Metric value properties.", - "type": "string", - "readOnly": true - } - } - }, - "HealthStatus": { - "readOnly": true, - "description": "Current health status.", - "type": "string", - "enum": [ - "Unknown", - "Healthy", - "Warning", - "Critical" - ], - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": true - } - }, - "Resource": { - "description": "Base resource object.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource Name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Resource location.", - "type": "string", - "readOnly": true - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "Service": { - "description": "Storage service.", - "properties": { - "version": { - "description": "Storage service version.", - "type": "string" - }, - "healthStatus": { - "description": "Health status of storage service.", - "$ref": "storage.json#/definitions/HealthStatus" - } - } - }, - "Operation": { - "description": "Describes the supported REST operation.", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "Contains the localized display information for this particular operation / action.", - "$ref": "storage.json#/definitions/Display", - "readOnly": true - } - } - }, - "Display": { - "description": "Contains the localized display information for this particular operation / action.", - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "The localized friendly name for the operation, as it should be shown to the user.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views.", - "type": "string", - "readOnly": true - } - } - }, - "OperationList": { - "description": "Pageable list of supported operations.", - "properties": { - "value": { - "description": "List of operations", - "type": "array", - "items": { - "$ref": "storage.json#/definitions/Operation" - } - }, - "nextLink": { - "description": "URI to the next page of operations.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "ServiceTypeParameter": { - "description": "The service type.", - "name": "serviceType", - "type": "string", - "in": "path", - "required": true, - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "ServiceType", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - }, - "ShareNameParameter": { - "description": "Share name.", - "name": "shareName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FilterParameter": { - "description": "Filter string", - "name": "$filter", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "LocationParameter": { - "description": "Resource location.", - "name": "location", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "SubscriptionIdParameter": { - "description": "Subscription Id.", - "name": "subscriptionId", - "type": "string", - "in": "path", - "required": true - }, - "FarmIdParameter": { - "description": "Farm Id.", - "type": "string", - "name": "farmId", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "description": "REST Api Version.", - "name": "api-version", - "type": "string", - "in": "query", - "required": true - }, - "ResourceGroupNameParameter": { - "description": "Resource group name.", - "name": "resourceGroupName", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "OperationIdParameter": { - "description": "Operation Id.", - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Storage.Admin/operations": { + "get": { + "x-ms-examples": { + "Get the list of support rest operations.": { + "$ref": "./examples/Operations/List.json" + } + }, + "description": "Get the list of support rest operations.", + "tags": [ + "Commerce" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of operations has been returned.", + "schema": { + "$ref": "storage.json#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "WritableSettings": { + "description": "Storage service settings.", + "type": "object", + "properties": { + "frontEndCallbackThreadsCount": { + "description": "Front end callback threads count.", + "type": "integer", + "format": "int32" + }, + "frontEndCpuBasedKeepAliveThrottlingEnabled": { + "description": "Switch of front end CPU based keep-alive throttling.", + "type": "boolean" + }, + "frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold": { + "description": "Threshold (% percentage) of front end CPU based keep-alive throttling.", + "type": "number", + "format": "float" + }, + "frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle": { + "description": "Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.", + "type": "number", + "format": "float" + }, + "frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds": { + "description": "Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.", + "type": "integer", + "format": "int32" + }, + "frontEndMemoryThrottlingEnabled": { + "description": "Switch of front end memory throttling.", + "type": "boolean" + }, + "frontEndMaxMillisecondsBetweenMemorySamples": { + "description": "Maxium interval (in millisecond) between memory samples of front end.", + "type": "integer", + "format": "int32" + }, + "frontEndMemoryThrottleThresholdSettings": { + "description": "Front end memory throttle threshold settings.", + "type": "string" + }, + "frontEndMinThreadPoolThreads": { + "description": "Front end minimum number of threads in thread pool.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveIOCompletionThreshold": { + "description": "Threshold of front end thread pool based keep-alive IO completion.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold": { + "description": "Threshold of front end thread pool based keep-alive worker thread.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds": { + "description": "Monitor interval (in seconds) of front end thread pool based keep-alive monitor.", + "type": "integer", + "format": "int32" + }, + "frontEndThreadPoolBasedKeepAlivePercentage": { + "description": "Percentage (%) of front end thread pool based keep-alive.", + "type": "number", + "format": "float" + }, + "frontEndUseSlaTimeInAvailability": { + "description": "Switch of whether front end uses SLA time in availability.", + "type": "boolean" + } + } + }, + "WritableServiceSettings": { + "description": "Settings of storage services.", + "type": "object", + "properties": { + "frontEndHttpsListenPort": { + "description": "The HTTPs port of the storage service front end.", + "type": "integer", + "format": "int32" + }, + "frontEndHttpListenPort": { + "description": "The HTTP port of the storage service front end.", + "type": "integer", + "format": "int32" + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/WritableSettings" + } + ] + }, + "LocalizableString": { + "description": "Localizable string.", + "type": "object", + "properties": { + "value": { + "description": "Value of the string.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of the string.", + "type": "string" + } + } + }, + "MetricAvailability": { + "description": "Metric availability.", + "type": "object", + "properties": { + "timeGrain": { + "description": "Time grain.", + "type": "string" + }, + "retention": { + "description": "Retention of metric.", + "type": "string" + } + } + }, + "AggregateType": { + "description": "Aggregate type.", + "readOnly": true, + "type": "string", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "name": "AggregateType", + "modelAsString": true + } + }, + "MetricUnit": { + "description": "Metric unit.", + "type": "string", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "MetricDefinition": { + "description": "Metric definition.", + "type": "object", + "properties": { + "name": { + "description": "Metric name.", + "$ref": "storage.json#/definitions/LocalizableString", + "readOnly": true + }, + "unit": { + "description": "Metric unit.", + "$ref": "storage.json#/definitions/MetricUnit", + "readOnly": true + }, + "primaryAggregationType": { + "description": "Aggregation type of metric.", + "$ref": "storage.json#/definitions/AggregateType", + "readOnly": true + }, + "metricAvailabilities": { + "description": "Metric availabilities.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricAvailability" + }, + "readOnly": true + } + } + }, + "Metric": { + "description": "Metric information.", + "type": "object", + "properties": { + "name": { + "description": "Metric Name.", + "$ref": "storage.json#/definitions/LocalizableString", + "readOnly": true + }, + "metricUnit": { + "description": "Metric Unit.", + "$ref": "storage.json#/definitions/MetricUnit", + "readOnly": true + }, + "timeGrain": { + "description": "Metric time grain.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Metric start time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "Metric end time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "metricValues": { + "description": "List of metric values.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricValue" + }, + "readOnly": true + } + } + }, + "MetricDefinitionList": { + "description": "Pageable list of metric definitions.", + "type": "object", + "properties": { + "value": { + "description": "List of metric definitions.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/MetricDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "MetricList": { + "description": "Pageable list of metrics.", + "type": "object", + "properties": { + "value": { + "description": "List of metrics.", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/Metric" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + }, + "MetricValue": { + "description": "Metric value.", + "properties": { + "timeStamp": { + "description": "Timestamp of metric value.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "average": { + "description": "Average value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "minimum": { + "description": "Minimum value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "maximum": { + "description": "Maximum value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "total": { + "description": "Total value of metric.", + "type": "number", + "format": "float", + "readOnly": true + }, + "count": { + "description": "Count of metric values.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "properties": { + "description": "Metric value properties.", + "type": "string", + "readOnly": true + } + } + }, + "HealthStatus": { + "readOnly": true, + "description": "Current health status.", + "type": "string", + "enum": [ + "Unknown", + "Healthy", + "Warning", + "Critical" + ], + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "Resource": { + "description": "Base resource object.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "Service": { + "description": "Storage service.", + "properties": { + "version": { + "description": "Storage service version.", + "type": "string" + }, + "healthStatus": { + "description": "Health status of storage service.", + "$ref": "storage.json#/definitions/HealthStatus" + } + } + }, + "Operation": { + "description": "Describes the supported REST operation.", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "$ref": "storage.json#/definitions/Display", + "readOnly": true + } + } + }, + "Display": { + "description": "Contains the localized display information for this particular operation / action.", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation – it should match the public documentation for the resource provider.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation, as it should be shown to the user.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views.", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "Pageable list of supported operations.", + "properties": { + "value": { + "description": "List of operations", + "type": "array", + "items": { + "$ref": "storage.json#/definitions/Operation" + } + }, + "nextLink": { + "description": "URI to the next page of operations.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServiceTypeParameter": { + "description": "The service type.", + "name": "serviceType", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "ShareNameParameter": { + "description": "Share name.", + "name": "shareName", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "description": "Filter string", + "name": "$filter", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "description": "Resource location.", + "name": "location", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "description": "Subscription Id.", + "name": "subscriptionId", + "type": "string", + "in": "path", + "required": true + }, + "FarmIdParameter": { + "description": "Farm Id.", + "type": "string", + "name": "farmId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "description": "REST Api Version.", + "name": "api-version", + "type": "string", + "in": "query", + "required": true + }, + "ResourceGroupNameParameter": { + "description": "Resource group name.", + "name": "resourceGroupName", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "description": "Operation Id.", + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json index 7820cb16398c..e1cf42d9f535 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json @@ -1,441 +1,441 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts": { - "get": { - "x-ms-examples": { - "Returns a list of storage accounts.": { - "$ref": "./examples/StorageAccounts/List.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Returns a list of storage accounts.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "storageaccounts.json#/parameters/SummaryParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of storage accounts has been returned.", - "schema": { - "$ref": "storageaccounts.json#/definitions/StorageAccountList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts/{accountId}": { - "get": { - "x-ms-examples": { - "Returns the requested storage account.": { - "$ref": "./examples/StorageAccounts/Get.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Get", - "description": "Returns the requested storage account.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storageaccounts.json#/parameters/AccountIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The storage account has been returned.", - "schema": { - "$ref": "storageaccounts.json#/definitions/StorageAccount" - } - }, - "404": { - "description": "NOT FOUND -- The storage account or farm was not found." - } - } - }, - "post": { - "x-ms-examples": { - "Undelete a deleted storage account.": { - "$ref": "./examples/StorageAccounts/Undelete.json" - } - }, - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Undelete", - "description": "Undelete a deleted storage account.", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storageaccounts.json#/parameters/AccountIdParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Undelete either has been performed or account was not deleted." - } - } - } - } - }, - "definitions": { - "StorageAccountState": { - "readOnly": true, - "description": "Storage account state.", - "type": "string", - "enum": [ - "Creating", - "Succeeded", - "Suspended" - ], - "x-ms-enum": { - "name": "StorageAccountState", - "modelAsString": true - } - }, - "StorageAccountType": { - "description": "Storage account type.", - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_ZRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountType", - "modelAsString": true - } - }, - "LocationStatus": { - "readOnly": true, - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "LocationStatus", - "modelAsString": true - } - }, - "StorageAccountOperation": { - "readOnly": true, - "description": "The permissions of storage account in WAC.", - "type": "string", - "enum": [ - "None", - "Create", - "Update", - "Suspend", - "Delete", - "Undelete" - ], - "x-ms-enum": { - "name": "StorageAccountOperation", - "modelAsString": true - } - }, - "StorageAccountStatus": { - "description": "The state of storage account in WAC.", - "type": "string", - "enum": [ - "Active", - "Deleted", - "OutOfRetentionPeriod", - "Recycled" - ], - "x-ms-enum": { - "name": "StorageAccountStatus", - "modelAsString": true - } - }, - "WacAccountPermissions": { - "description": "Current operation being performed on Storage Account", - "type": "string", - "enum": [ - "Empty", - "None", - "Read", - "Delete", - "Write", - "Full" - ], - "x-ms-enum": { - "name": "WacAccountPermissions", - "modelAsString": true - } - }, - "WacAccountStates": { - "description": "Current operation being performed on Storage Account", - "type": "string", - "enum": [ - "None", - "Active", - "Deleted", - "AboveQuota", - "Suspended", - "All" - ], - "x-ms-enum": { - "name": "WacAccountStates", - "modelAsString": true - } - }, - "StorageAccountProperties": { - "description": "Properties of a storage account.", - "type": "object", - "properties": { - "tenantViewId": { - "description": "Resource URI of storage account from tenant view.", - "type": "string", - "readOnly": true - }, - "accountType": { - "description": "Storage account type.", - "$ref": "storageaccounts.json#/definitions/StorageAccountType", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning state of storage account.", - "$ref": "storageaccounts.json#/definitions/StorageAccountState", - "readOnly": true - }, - "primaryEndpoints": { - "description": "The URLs that are used to perform a retrieval of a public BLOB, queue, or table object.", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - }, - "creationTime": { - "description": "The creation date and time of storage account in UTC.", - "type": "string", - "readOnly": true - }, - "alternateName": { - "description": "Alternative storage account name being used during undelete operation.", - "type": "string", - "readOnly": true - }, - "primaryLocation": { - "description": "The primary location for the storage account.", - "type": "string", - "readOnly": true - }, - "statusOfPrimary": { - "description": "The status of primary location of storage account.", - "$ref": "storageaccounts.json#/definitions/LocationStatus", - "readOnly": true - }, - "tenantSubscriptionId": { - "description": "Subscription ID of the subscription under which the storage account locates.", - "type": "string", - "readOnly": true - }, - "tenantStorageAccountName": { - "description": "Storage account name from tenant view.", - "type": "string", - "readOnly": true - }, - "tenantResourceGroupName": { - "description": "The name of resource group under which the storage account locates.", - "type": "string", - "readOnly": true - }, - "currentOperation": { - "description": "Current operation being performed on Storage Account", - "$ref": "storageaccounts.json#/definitions/StorageAccountOperation", - "readOnly": true - }, - "customDomain": { - "description": "The custom domain the user assigned to this storage account.", - "type": "string", - "readOnly": true - }, - "acquisitionOperationCount": { - "description": "The count of acquisitions in the storage account.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "deletedTime": { - "description": "The date-time when the storage account was deleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "accountStatus": { - "$ref": "storageaccounts.json#/definitions/StorageAccountStatus", - "description": "The status of storage account." - }, - "recoveredTime": { - "description": "The time when the storage account is undeleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "recycledTime": { - "description": "The time when the storage account is physically deleted.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "permissions": { - "description": "The permissions on the storage account.", - "$ref": "storageaccounts.json#/definitions/WacAccountPermissions", - "readOnly": true - }, - "accountId": { - "description": "Internal storage account ID, which is not visible to tenant.", - "type": "string", - "readOnly": true - }, - "wacInternalState": { - "description": "The internal state of storage account in WAC.", - "$ref": "storageaccounts.json#/definitions/WacAccountStates", - "readOnly": true - }, - "resourceAdminApiVersion": { - "description": "Storage admin REST API version.", - "type": "string", - "readOnly": true - } - } - }, - "StorageAccount": { - "description": "Properties of the storage account.", - "type": "object", - "properties": { - "properties": { - "description": "Properties of the storage account.", - "x-ms-client-flatten": true, - "$ref": "storageaccounts.json#/definitions/StorageAccountProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "StorageAccountList": { - "description": "Pageable list of storage accounts.", - "type": "object", - "properties": { - "value": { - "description": "List of storage accounts.", - "type": "array", - "items": { - "$ref": "storageaccounts.json#/definitions/StorageAccount" - }, - "readOnly": true - }, - "nextLink": { - "description": "URI to the next page.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "AccountIdParameter": { - "description": "Internal storage account ID, which is not visible to tenant.", - "name": "accountId", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SummaryParameter": { - "description": "Switch for whether summary or detailed information is returned.", - "name": "summary", - "in": "query", - "required": true, - "type": "boolean", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts": { + "get": { + "x-ms-examples": { + "Returns a list of storage accounts.": { + "$ref": "./examples/StorageAccounts/List.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Returns a list of storage accounts.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/SummaryParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of storage accounts has been returned.", + "schema": { + "$ref": "storageaccounts.json#/definitions/StorageAccountList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/storageaccounts/{accountId}": { + "get": { + "x-ms-examples": { + "Returns the requested storage account.": { + "$ref": "./examples/StorageAccounts/Get.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Get", + "description": "Returns the requested storage account.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/AccountIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The storage account has been returned.", + "schema": { + "$ref": "storageaccounts.json#/definitions/StorageAccount" + } + }, + "404": { + "description": "NOT FOUND -- The storage account or farm was not found." + } + } + }, + "post": { + "x-ms-examples": { + "Undelete a deleted storage account.": { + "$ref": "./examples/StorageAccounts/Undelete.json" + } + }, + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Undelete", + "description": "Undelete a deleted storage account.", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storageaccounts.json#/parameters/AccountIdParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Undelete either has been performed or account was not deleted." + } + } + } + } + }, + "definitions": { + "StorageAccountState": { + "readOnly": true, + "description": "Storage account state.", + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Suspended" + ], + "x-ms-enum": { + "name": "StorageAccountState", + "modelAsString": true + } + }, + "StorageAccountType": { + "description": "Storage account type.", + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "LocationStatus": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "LocationStatus", + "modelAsString": true + } + }, + "StorageAccountOperation": { + "readOnly": true, + "description": "The permissions of storage account in WAC.", + "type": "string", + "enum": [ + "None", + "Create", + "Update", + "Suspend", + "Delete", + "Undelete" + ], + "x-ms-enum": { + "name": "StorageAccountOperation", + "modelAsString": true + } + }, + "StorageAccountStatus": { + "description": "The state of storage account in WAC.", + "type": "string", + "enum": [ + "Active", + "Deleted", + "OutOfRetentionPeriod", + "Recycled" + ], + "x-ms-enum": { + "name": "StorageAccountStatus", + "modelAsString": true + } + }, + "WacAccountPermissions": { + "description": "Current operation being performed on Storage Account", + "type": "string", + "enum": [ + "Empty", + "None", + "Read", + "Delete", + "Write", + "Full" + ], + "x-ms-enum": { + "name": "WacAccountPermissions", + "modelAsString": true + } + }, + "WacAccountStates": { + "description": "Current operation being performed on Storage Account", + "type": "string", + "enum": [ + "None", + "Active", + "Deleted", + "AboveQuota", + "Suspended", + "All" + ], + "x-ms-enum": { + "name": "WacAccountStates", + "modelAsString": true + } + }, + "StorageAccountProperties": { + "description": "Properties of a storage account.", + "type": "object", + "properties": { + "tenantViewId": { + "description": "Resource URI of storage account from tenant view.", + "type": "string", + "readOnly": true + }, + "accountType": { + "description": "Storage account type.", + "$ref": "storageaccounts.json#/definitions/StorageAccountType", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of storage account.", + "$ref": "storageaccounts.json#/definitions/StorageAccountState", + "readOnly": true + }, + "primaryEndpoints": { + "description": "The URLs that are used to perform a retrieval of a public BLOB, queue, or table object.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "creationTime": { + "description": "The creation date and time of storage account in UTC.", + "type": "string", + "readOnly": true + }, + "alternateName": { + "description": "Alternative storage account name being used during undelete operation.", + "type": "string", + "readOnly": true + }, + "primaryLocation": { + "description": "The primary location for the storage account.", + "type": "string", + "readOnly": true + }, + "statusOfPrimary": { + "description": "The status of primary location of storage account.", + "$ref": "storageaccounts.json#/definitions/LocationStatus", + "readOnly": true + }, + "tenantSubscriptionId": { + "description": "Subscription ID of the subscription under which the storage account locates.", + "type": "string", + "readOnly": true + }, + "tenantStorageAccountName": { + "description": "Storage account name from tenant view.", + "type": "string", + "readOnly": true + }, + "tenantResourceGroupName": { + "description": "The name of resource group under which the storage account locates.", + "type": "string", + "readOnly": true + }, + "currentOperation": { + "description": "Current operation being performed on Storage Account", + "$ref": "storageaccounts.json#/definitions/StorageAccountOperation", + "readOnly": true + }, + "customDomain": { + "description": "The custom domain the user assigned to this storage account.", + "type": "string", + "readOnly": true + }, + "acquisitionOperationCount": { + "description": "The count of acquisitions in the storage account.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "deletedTime": { + "description": "The date-time when the storage account was deleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "accountStatus": { + "$ref": "storageaccounts.json#/definitions/StorageAccountStatus", + "description": "The status of storage account." + }, + "recoveredTime": { + "description": "The time when the storage account is undeleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "recycledTime": { + "description": "The time when the storage account is physically deleted.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "permissions": { + "description": "The permissions on the storage account.", + "$ref": "storageaccounts.json#/definitions/WacAccountPermissions", + "readOnly": true + }, + "accountId": { + "description": "Internal storage account ID, which is not visible to tenant.", + "type": "string", + "readOnly": true + }, + "wacInternalState": { + "description": "The internal state of storage account in WAC.", + "$ref": "storageaccounts.json#/definitions/WacAccountStates", + "readOnly": true + }, + "resourceAdminApiVersion": { + "description": "Storage admin REST API version.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccount": { + "description": "Properties of the storage account.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of the storage account.", + "x-ms-client-flatten": true, + "$ref": "storageaccounts.json#/definitions/StorageAccountProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "StorageAccountList": { + "description": "Pageable list of storage accounts.", + "type": "object", + "properties": { + "value": { + "description": "List of storage accounts.", + "type": "array", + "items": { + "$ref": "storageaccounts.json#/definitions/StorageAccount" + }, + "readOnly": true + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "AccountIdParameter": { + "description": "Internal storage account ID, which is not visible to tenant.", + "name": "accountId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SummaryParameter": { + "description": "Switch for whether summary or detailed information is returned.", + "name": "summary", + "in": "query", + "required": true, + "type": "boolean", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json index 528e83417535..80777a72ffff 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json @@ -1,207 +1,207 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-12-01-preview", - "title": "StorageManagementClient", - "description": "The Admin Storage Management Client." - }, - "host": "adminmanagement.local.azurestack.external", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}": { - "get": { - "x-ms-examples": { - "Returns the table servie.": { - "$ref": "./examples/TableService/Get.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns the table servie.", - "operationId": "TableServices_Get", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- Table service has been returned.", - "schema": { - "$ref": "tableServices.json#/definitions/TableService" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metricdefinitions": { - "get": { - "x-ms-examples": { - "Returns a list of metric definitions for table service.": { - "$ref": "./examples/TableService/ListMetricDefinitions.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns a list of metric definitions for table service.", - "operationId": "TableServices_ListMetricDefinitions", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metric definitions has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricDefinitionList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metrics": { - "get": { - "x-ms-examples": { - "Returns a list of metrics for table service.": { - "$ref": "./examples/TableService/ListMetrics.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns a list of metrics for table service.", - "operationId": "TableServices_ListMetrics", - "parameters": [ - { - "$ref": "storage.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "storage.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "storage.json#/parameters/FarmIdParameter" - }, - { - "$ref": "storage.json#/parameters/ServiceTypeParameter" - }, - { - "$ref": "storage.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK -- The list of metrics has been returned.", - "schema": { - "$ref": "storage.json#/definitions/MetricList" - } - }, - "404": { - "description": "NOT FOUND -- The specified farm was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "TableService": { - "description": "Table service.", - "type": "object", - "properties": { - "properties": { - "description": "Table service properties.", - "x-ms-client-flatten": true, - "$ref": "tableServices.json#/definitions/TableServiceProperties", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Resource" - } - ] - }, - "TableServiceProperties": { - "description": "Table service properties.", - "type": "object", - "properties": { - "settings": { - "description": "Table service settings.", - "x-ms-client-flatten": true, - "$ref": "storage.json#/definitions/WritableServiceSettings", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "storage.json#/definitions/Service" - } - ] - } - }, - "parameters": {}, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Authorization uses an Azure Active Directory OAuth2 flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] -} +{ + "swagger": "2.0", + "info": { + "version": "2015-12-01-preview", + "title": "StorageManagementClient", + "description": "The Admin Storage Management Client." + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}": { + "get": { + "x-ms-examples": { + "Returns the table servie.": { + "$ref": "./examples/TableService/Get.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns the table servie.", + "operationId": "TableServices_Get", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Table service has been returned.", + "schema": { + "$ref": "tableServices.json#/definitions/TableService" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metricdefinitions": { + "get": { + "x-ms-examples": { + "Returns a list of metric definitions for table service.": { + "$ref": "./examples/TableService/ListMetricDefinitions.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns a list of metric definitions for table service.", + "operationId": "TableServices_ListMetricDefinitions", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metric definitions has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricDefinitionList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}/metrics": { + "get": { + "x-ms-examples": { + "Returns a list of metrics for table service.": { + "$ref": "./examples/TableService/ListMetrics.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns a list of metrics for table service.", + "operationId": "TableServices_ListMetrics", + "parameters": [ + { + "$ref": "storage.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "storage.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "storage.json#/parameters/FarmIdParameter" + }, + { + "$ref": "storage.json#/parameters/ServiceTypeParameter" + }, + { + "$ref": "storage.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The list of metrics has been returned.", + "schema": { + "$ref": "storage.json#/definitions/MetricList" + } + }, + "404": { + "description": "NOT FOUND -- The specified farm was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TableService": { + "description": "Table service.", + "type": "object", + "properties": { + "properties": { + "description": "Table service properties.", + "x-ms-client-flatten": true, + "$ref": "tableServices.json#/definitions/TableServiceProperties", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Resource" + } + ] + }, + "TableServiceProperties": { + "description": "Table service properties.", + "type": "object", + "properties": { + "settings": { + "description": "Table service settings.", + "x-ms-client-flatten": true, + "$ref": "storage.json#/definitions/WritableServiceSettings", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "storage.json#/definitions/Service" + } + ] + } + }, + "parameters": {}, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersDelete.json index eec47eceacd7..8467ea439f42 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersGet.json index 0d4827a551e9..108bf82c9653 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersList.json index 2cfa287edaac..7b890974902d 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersList.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "api-version": "2017-09-07-privatepreview" diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersListByResourceGroup.json index 417004d0553e..085a4a5cb720 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersListByResourceGroup.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersListByResourceGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersUpdate.json index 101e322f90e6..5c4dbc44dd1a 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoClustersUpdate.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesDelete.json index 02b7d9d27903..fe16ba02ae82 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesDelete.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesGet.json index 4221ae88fd0a..c2dab48c162f 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesGet.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesListByCluster.json index 1f4cae96a677..59f3a20aa261 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesListByCluster.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesListByCluster.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesUpdate.json index 1121894720f7..43fc0a2e0680 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesUpdate.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoDatabasesUpdate.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "12345678-1234-1234-1234-123456789098", "resourceGroupName": "kustorptest", diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoOperationsList.json index daf102011299..11ac19fdb7a2 100644 --- a/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoOperationsList.json +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/examples/KustoOperationsList.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-09-07-privatepreview" }, diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json index 9a989687b1d7..be8d14d6ac98 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json @@ -14176,4 +14176,4 @@ } } } - + diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json index 38fb75cbe280..2a85fd554199 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json @@ -14394,4 +14394,4 @@ } } } - + diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-01-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-01-01/BatchManagement.json index 2107873692f3..6e41d31d955a 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-01-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-01-01/BatchManagement.json @@ -1574,4 +1574,4 @@ "description": "The API version to be used with the HTTP request." } } -} +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json index 180667c90d81..027c98784269 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-02-27-preview/billing.json @@ -407,4 +407,4 @@ "type": "string" } } -} +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json index 47726b6c1721..2367bb4f64c5 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json @@ -582,4 +582,4 @@ "type": "string" } } -} +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json index 0b368eefc5c7..9b6c586818fc 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json @@ -1,2249 +1,2249 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Bot Service", - "description": "Azure Bot Service is a platform for creating smart conversational agents.", - "version": "2017-12-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": { - "put": { - "tags": [ - "Bot" - ], - "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.", - "operationId": "Bots_Create", - "x-ms-examples": { - "Create Bot": { - "$ref": "./examples/CreateBot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Bot" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is created successfully or already existed, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/Bot" - } - }, - "201": { - "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/Bot" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "Bot" - ], - "description": "Updates a Bot Service", - "operationId": "Bots_Update", - "x-ms-examples": { - "Update Bot": { - "$ref": "./examples/UpdateBot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "x-ms-client-flatten": true, - "schema": { - "$ref": "#/definitions/Bot" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/Bot" - } - }, - "201": { - "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/Bot" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "delete": { - "tags": [ - "Bot" - ], - "description": "Deletes a Bot Service from the resource group. ", - "operationId": "Bots_Delete", - "x-ms-examples": { - "Delete Bot": { - "$ref": "./examples/DeleteBot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" - }, - "204": { - "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Bot" - ], - "description": "Returns a BotService specified by the parameters.", - "operationId": "Bots_Get", - "x-ms-examples": { - "Get Bot": { - "$ref": "./examples/GetBot.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/Bot" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": { - "get": { - "tags": [ - "Bot" - ], - "description": "Returns all the resources of a particular type belonging to a resource group", - "operationId": "Bots_ListByResourceGroup", - "x-ms-examples": { - "List Bots by Resource Group": { - "$ref": "./examples/ListBotsByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", - "schema": { - "$ref": "#/definitions/BotResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": { - "get": { - "tags": [ - "Bot" - ], - "description": "Returns all the resources of a particular type belonging to a subscription.", - "operationId": "Bots_List", - "x-ms-examples": { - "List Bots by Subscription": { - "$ref": "./examples/ListBotsBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", - "schema": { - "$ref": "#/definitions/BotResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}": { - "put": { - "tags": [ - "Channel" - ], - "description": "Creates a Channel registration for a Bot Service", - "operationId": "Channels_Create", - "x-ms-examples": { - "Create Bot": { - "$ref": "./examples/PutChannel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/channelNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BotChannel" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is created successfully or already existed, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "201": { - "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "Channel" - ], - "description": "Updates a Channel registration for a Bot Service", - "operationId": "Channels_Update", - "x-ms-examples": { - "Update Bot": { - "$ref": "./examples/UpdateChannel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/channelNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "x-ms-client-flatten": true, - "schema": { - "$ref": "#/definitions/BotChannel" - }, - "description": "The parameters to provide for the created bot." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "201": { - "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "delete": { - "tags": [ - "Channel" - ], - "description": "Deletes a Channel registration from a Bot Service", - "operationId": "Channels_Delete", - "x-ms-examples": { - "Delete Bot": { - "$ref": "./examples/DeleteChannel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "name": "channelName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" - }, - "204": { - "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "Channel" - ], - "description": "Returns a BotService Channel registration specified by the parameters.", - "operationId": "Channels_Get", - "x-ms-examples": { - "Get Bot": { - "$ref": "./examples/GetChannel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "name": "channelName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys": { - "post": { - "tags": [ - "Channel" - ], - "description": "Lists a Channel registration for a Bot Service including secrets", - "operationId": "Channels_ListWithKeys", - "x-ms-examples": { - "List Channel": { - "$ref": "./examples/ListChannel.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/channelNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is retrieved successfully, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/BotChannel" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels": { - "get": { - "tags": [ - "Channel" - ], - "description": "Returns all the Channel registrations of a particular BotService resource", - "operationId": "Channels_ListByResourceGroup", - "x-ms-examples": { - "List Bots by Resource Group": { - "$ref": "./examples/ListChannelsByBotService.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", - "schema": { - "$ref": "#/definitions/ChannelResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.BotService/botServices/checkNameAvailability": { - "get": { - "tags": [ - "Bot" - ], - "description": "Check whether a bot name is available.", - "operationId": "Bots_GetCheckNameAvailability", - "x-ms-examples": { - "List Bots by Subscription": { - "$ref": "./examples/CheckNameAvailability.json" - } - }, - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityRequestBody" - }, - "description": "The request body parameters to provide for the check name availability request" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResponseBody" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/providers/Microsoft.BotService/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all the available BotService operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get Operations": { - "$ref": "./examples/GetOperations.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders": { - "post": { - "tags": [ - "ListServiceProviders" - ], - "description": "Lists the available Service Providers for creating Connection Settings", - "operationId": "BotConnection_ListServiceProviders", - "x-ms-examples": { - "List Auth Service Providers": { - "$ref": "./examples/ListServiceProviders.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is retrieved successfully, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/ServiceProviderResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets": { - "post": { - "tags": [ - "BotConnection" - ], - "x-ms-examples": { - "Update Connection Setting": { - "$ref": "./examples/GetConnection.json" - } - }, - "description": "Get a Connection Setting registration for a Bot Service", - "operationId": "BotConnection_ListWithSecrets", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}": { - "put": { - "tags": [ - "BotConnection" - ], - "description": "Register a new Auth Connection for a Bot Service", - "operationId": "BotConnection_Create", - "x-ms-examples": { - "Create Connection Setting": { - "$ref": "./examples/PutConnection.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConnectionSetting" - }, - "description": "The parameters to provide for creating the Connection Setting." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is created successfully or already existed, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "201": { - "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "patch": { - "tags": [ - "BotConnection" - ], - "description": "Updates a Connection Setting registration for a Bot Service", - "operationId": "BotConnection_Update", - "x-ms-examples": { - "Update Connection Setting": { - "$ref": "./examples/UpdateConnection.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ConnectionSetting" - }, - "description": "The parameters to provide for updating the Connection Setting." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "If resource is created successfully or already existed, the service should return 200 (OK).", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "201": { - "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "get": { - "tags": [ - "BotConnection" - ], - "x-ms-examples": { - "Update Connection Setting": { - "$ref": "./examples/GetConnection.json" - } - }, - "description": "Get a Connection Setting registration for a Bot Service", - "operationId": "BotConnection_Get", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", - "schema": { - "$ref": "#/definitions/ConnectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - }, - "delete": { - "tags": [ - "BotConnection" - ], - "description": "Deletes a Connection Setting registration for a Bot Service", - "operationId": "BotConnection_Delete", - "x-ms-examples": { - "Update Connection Setting": { - "$ref": "./examples/DeleteConnection.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/connectionNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" - }, - "204": { - "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/Error" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections": { - "get": { - "tags": [ - "BotConnection" - ], - "description": "Returns all the Connection Settings registered to a particular BotService resource", - "operationId": "BotConnection_ListByBotService", - "x-ms-examples": { - "List Connection Settings": { - "$ref": "./examples/ListConnectionsByBotService.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", - "schema": { - "$ref": "#/definitions/ConnectionSettingResponseList" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", - "schema": { - "$ref": "#/definitions/Error" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Resource": { - "description": "Azure resource", - "x-ms-azure-resource": true, - "properties": { - "id": { - "description": "Specifies the resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Specifies the name of the resource.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "Specifies the location of the resource.", - "type": "string" - }, - "type": { - "description": "Specifies the type of the resource.", - "type": "string", - "readOnly": true - }, - "tags": { - "description": "Contains resource tags defined as key/value pairs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the resource." - }, - "kind": { - "$ref": "#/definitions/Kind", - "description": "Required. Gets or sets the Kind of the resource." - }, - "etag": { - "type": "string", - "description": "Entity Tag" - } - } - }, - "Sku": { - "properties": { - "name": { - "$ref": "#/definitions/SkuName", - "description": "The sku name" - }, - "tier": { - "readOnly": true, - "type": "string", - "description": "Gets the sku tier. This is based on the SKU name.", - "enum": [ - "Free", - "Standard" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": true - } - } - }, - "required": [ - "name" - ], - "description": "The SKU of the cognitive services account." - }, - "SkuName": { - "type": "string", - "description": "The name of SKU.", - "enum": [ - "F0", - "S1" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "Kind": { - "type": "string", - "description": "Indicates the type of bot service", - "enum": [ - "sdk", - "designer", - "bot", - "function" - ], - "x-ms-enum": { - "name": "Kind", - "modelAsString": true - } - }, - "Bot": { - "type": "object", - "description": "Bot resource definition", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BotProperties", - "description": "The set of properties specific to bot resource" - } - } - }, - "BotProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "The Name of the bot" - }, - "description": { - "type": "string", - "description": "The description of the bot" - }, - "iconUrl": { - "type": "string", - "description": "The Icon Url of the bot" - }, - "endpoint": { - "type": "string", - "description": "The bot's endpoint" - }, - "endpointVersion": { - "type": "string", - "readOnly": true, - "description": "The bot's endpoint version" - }, - "msaAppId": { - "type": "string", - "description": "Microsoft App Id for the bot" - }, - "configuredChannels": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Collection of channels for which the bot is configured" - }, - "enabledChannels": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Collection of channels for which the bot is enabled" - }, - "developerAppInsightKey": { - "type": "string", - "description": "The Application Insights key" - }, - "developerAppInsightsApiKey": { - "type": "string", - "description": "The Application Insights Api Key" - }, - "developerAppInsightsApplicationId": { - "type": "string", - "description": "The Application Insights App Id" - }, - "luisAppIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of LUIS App Ids" - }, - "luisKey": { - "type": "string", - "description": "The LUIS Key" - } - }, - "description": "The parameters to provide for the Bot.", - "required": [ - "displayName", - "endpoint", - "msaAppId" - ] - }, - "BotResponseList": { - "properties": { - "nextLink": { - "description": "The link used to get the next page of bot service resources.", - "type": "string" - }, - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Bot" - }, - "description": "Gets the list of bot service results and their properties." - } - }, - "description": "The list of bot service operation response." - }, - "BotChannel": { - "type": "object", - "description": "Bot channel resource definition", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/Channel", - "description": "The set of properties specific to bot channel resource" - } - } - }, - "Channel": { - "type": "object", - "description": "Channel definition", - "discriminator": "channelName", - "properties": { - "channelName": { - "type": "string", - "description": "The channel name" - } - }, - "required": [ - "channelName" - ] - }, - "FacebookChannel": { - "type": "object", - "description": "Facebook channel definition", - "x-ms-discriminator-value": "FacebookChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/FacebookChannelProperties", - "description": "The set of properties specific to bot facebook channel" - } - } - }, - "FacebookChannelProperties": { - "properties": { - "verifyToken": { - "type": "string", - "readOnly": true, - "description": "Verify token. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "pages": { - "type": "array", - "items": { - "$ref": "#/definitions/FacebookPage" - }, - "description": "The list of Facebook pages" - }, - "appId": { - "type": "string", - "description": "Facebook application id" - }, - "appSecret": { - "type": "string", - "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "callbackUrl": { - "type": "string", - "readOnly": true, - "description": "Callback Url" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Facebook channel.", - "required": [ - "appId", - "appSecret", - "isEnabled" - ] - }, - "FacebookPage": { - "properties": { - "id": { - "type": "string", - "description": "Page id" - }, - "accessToken": { - "type": "string", - "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." - } - }, - "description": "A Facebook page for Facebook channel registration", - "required": [ - "id", - "accessToken" - ] - }, - "EmailChannel": { - "type": "object", - "description": "Email channel definition", - "x-ms-discriminator-value": "EmailChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/EmailChannelProperties", - "description": "The set of properties specific to email channel resource" - } - } - }, - "EmailChannelProperties": { - "properties": { - "emailAddress": { - "type": "string", - "description": "The email address" - }, - "password": { - "type": "string", - "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Email channel.", - "required": [ - "emailAddress", - "password", - "isEnabled" - ] - }, - "MsTeamsChannel": { - "type": "object", - "x-ms-discriminator-value": "MsTeamsChannel", - "description": "Microsoft Teams channel definition", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/MsTeamsChannelProperties", - "description": "The set of properties specific to Microsoft Teams channel resource" - } - } - }, - "MsTeamsChannelProperties": { - "properties": { - "enableMessaging": { - "type": "boolean", - "description": "Enable messaging for Microsoft Teams channel" - }, - "enableMediaCards": { - "type": "boolean", - "description": "Enable media cards for Microsoft Teams channel" - }, - "enableVideo": { - "type": "boolean", - "description": "Enable video for Microsoft Teams channel" - }, - "enableCalling": { - "type": "boolean", - "description": "Enable calling for Microsoft Teams channel" - }, - "callMode": { - "type": "string", - "description": "Enable messaging for Microsoft Teams channel" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Microsoft Teams channel.", - "required": [ - "isEnabled" - ] - }, - "SkypeChannel": { - "type": "object", - "description": "Skype channel definition", - "x-ms-discriminator-value": "SkypeChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SkypeChannelProperties", - "description": "The set of properties specific to Skype channel resource" - } - } - }, - "SkypeChannelProperties": { - "properties": { - "enableMessaging": { - "type": "boolean", - "description": "Enable messaging for Skype channel" - }, - "enableMediaCards": { - "type": "boolean", - "description": "Enable media cards for Skype channel" - }, - "enableVideo": { - "type": "boolean", - "description": "Enable video for Skype channel" - }, - "enableCalling": { - "type": "boolean", - "description": "Enable calling for Skype channel" - }, - "enableScreenSharing": { - "type": "boolean", - "description": "Enable screen sharing for Skype channel" - }, - "enableGroups": { - "type": "boolean", - "description": "Enable groups for Skype channel" - }, - "groupsMode": { - "type": "string", - "description": "Group mode for Skype channel" - }, - "callingWebHook": { - "type": "string", - "description": "Calling web hook for Skype channel" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Microsoft Teams channel.", - "required": [ - "isEnabled" - ] - }, - "KikChannel": { - "type": "object", - "x-ms-discriminator-value": "KikChannel", - "description": "Kik channel definition", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/KikChannelProperties", - "description": "The set of properties specific to Kik channel resource" - } - } - }, - "KikChannelProperties": { - "properties": { - "userName": { - "type": "string", - "description": "The Kik user name" - }, - "apiKey": { - "type": "string", - "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "isValidated": { - "type": "boolean", - "description": "Whether this channel is validated for the bot" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Kik channel.", - "required": [ - "userName", - "apiKey", - "isEnabled" - ] - }, - "WebChatChannel": { - "type": "object", - "x-ms-discriminator-value": "WebChatChannel", - "description": "Web Chat channel definition", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/WebChatChannelProperties", - "description": "The set of properties specific to Web Chat channel resource" - } - } - }, - "WebChatChannelProperties": { - "properties": { - "webChatEmbedCode": { - "type": "string", - "x-ms-mutability": [ - "read" - ], - "readOnly": true, - "description": "Web chat control embed code" - }, - "sites": { - "type": "array", - "items": { - "$ref": "#/definitions/WebChatSite" - }, - "description": "The list of Web Chat sites" - } - }, - "description": "The parameters to provide for the Web Chat channel." - }, - "DirectLineChannel": { - "type": "object", - "x-ms-discriminator-value": "DirectLineChannel", - "description": "Direct Line channel definition", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DirectLineChannelProperties", - "description": "The set of properties specific to Direct Line channel resource" - } - } - }, - "DirectLineChannelProperties": { - "properties": { - "sites": { - "type": "array", - "items": { - "$ref": "#/definitions/DirectLineSite" - }, - "description": "The list of Direct Line sites" - } - }, - "description": "The parameters to provide for the Direct Line channel." - }, - "TelegramChannel": { - "type": "object", - "description": "Telegram channel definition", - "x-ms-discriminator-value": "TelegramChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/TelegramChannelProperties", - "description": "The set of properties specific to Telegram channel resource" - } - } - }, - "TelegramChannelProperties": { - "properties": { - "accessToken": { - "type": "string", - "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "isValidated": { - "type": "boolean", - "description": "Whether this channel is validated for the bot" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Telegram channel.", - "required": [ - "accessToken", - "isEnabled" - ] - }, - "SmsChannel": { - "type": "object", - "description": "Sms channel definition", - "x-ms-discriminator-value": "SmsChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SmsChannelProperties", - "description": "The set of properties specific to Sms channel resource" - } - } - }, - "SmsChannelProperties": { - "properties": { - "phone": { - "type": "string", - "description": "The Sms phone" - }, - "accountSID": { - "type": "string", - "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "authToken": { - "type": "string", - "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "isValidated": { - "type": "boolean", - "description": "Whether this channel is validated for the bot" - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Sms channel.", - "required": [ - "phone", - "accountSID", - "authToken", - "isEnabled" - ] - }, - "SlackChannel": { - "type": "object", - "description": "Slack channel definition", - "x-ms-discriminator-value": "SlackChannel", - "allOf": [ - { - "$ref": "#/definitions/Channel" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SlackChannelProperties", - "description": "The set of properties specific to Slack channel resource" - } - } - }, - "SlackChannelProperties": { - "properties": { - "clientId": { - "type": "string", - "description": "The Slack client id" - }, - "clientSecret": { - "type": "string", - "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "verificationToken": { - "type": "string", - "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." - }, - "landingPageUrl": { - "type": "string", - "description": "The Slack landing page Url" - }, - "redirectAction": { - "type": "string", - "description": "The Slack redirect action", - "readOnly": true - }, - "lastSubmissionId": { - "type": "string", - "description": "The Sms auth token", - "readOnly": true - }, - "registerBeforeOAuthFlow": { - "type": "boolean", - "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.", - "readOnly": true - }, - "isValidated": { - "type": "boolean", - "description": "Whether this channel is validated for the bot", - "readOnly": true - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this channel is enabled for the bot" - } - }, - "description": "The parameters to provide for the Slack channel.", - "required": [ - "clientId", - "clientSecret", - "verificationToken", - "isEnabled" - ] - }, - "ChannelResponseList": { - "properties": { - "nextLink": { - "description": "The link used to get the next page of bot service channel resources.", - "type": "string" - }, - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/BotChannel" - }, - "description": "Gets the list of bot service channel results and their properties." - } - }, - "description": "The list of bot service channel operation response." - }, - "WebChatSite": { - "properties": { - "siteId": { - "type": "string", - "description": "Site Id", - "x-ms-mutability": [ - "read" - ], - "readOnly": true - }, - "siteName": { - "type": "string", - "description": "Site name" - }, - "key": { - "type": "string", - "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", - "x-ms-mutability": [ - "read" - ], - "readOnly": true - }, - "key2": { - "type": "string", - "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", - "x-ms-mutability": [ - "read" - ], - "readOnly": true - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this site is enabled for DirectLine channel" - }, - "enablePreview": { - "type": "boolean", - "description": "Whether this site is enabled for preview versions of Webchat" - } - }, - "required": [ - "siteName", - "isEnabled", - "enablePreview" - ], - "description": "A site for the Webchat channel" - }, - "DirectLineSite": { - "properties": { - "siteId": { - "x-ms-mutability": [ - "read" - ], - "type": "string", - "description": "Site Id", - "readOnly": true - }, - "siteName": { - "type": "string", - "description": "Site name" - }, - "key": { - "x-ms-mutability": [ - "read" - ], - "type": "string", - "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", - "readOnly": true - }, - "key2": { - "x-ms-mutability": [ - "read" - ], - "type": "string", - "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", - "readOnly": true - }, - "isEnabled": { - "type": "boolean", - "description": "Whether this site is enabled for DirectLine channel" - }, - "isV1Enabled": { - "type": "boolean", - "description": "Whether this site is enabled for Bot Framework V1 protocol" - }, - "isV3Enabled": { - "type": "boolean", - "description": "Whether this site is enabled for Bot Framework V1 protocol" - } - }, - "description": "A site for the Direct Line channel", - "required": [ - "isV1Enabled", - "isV3Enabled", - "isEnabled", - "siteName" - ] - }, - "ConnectionItemName": { - "properties": { - "name": { - "type": "string", - "description": "Connection Item name that has been added in the API", - "readOnly": true - } - }, - "description": "The display name of a connection Item Setting registered with the Bot" - }, - "ConnectionSettingParameter": { - "properties": { - "key": { - "type": "string", - "description": "Key for the Connection Setting Parameter." - }, - "value": { - "type": "string", - "description": "Value associated with the Connection Setting Parameter." - } - }, - "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" - }, - "ConnectionSettingProperties": { - "properties": { - "clientId": { - "type": "string", - "description": "Client Id associated with the Connection Setting." - }, - "settingId": { - "type": "string", - "description": "Setting Id set by the service for the Connection Setting.", - "readOnly": true - }, - "clientSecret": { - "type": "string", - "description": "Client Secret associated with the Connection Setting" - }, - "scopes": { - "type": "string", - "description": "Scopes associated with the Connection Setting" - }, - "serviceProviderId": { - "type": "string", - "description": "Service Provider Id associated with the Connection Setting" - }, - "serviceProviderDisplayName": { - "type": "string", - "description": "Service Provider Display Name associated with the Connection Setting" - }, - "parameters": { - "type": "array", - "description": "Service Provider Parameters associated with the Connection Setting", - "items": { - "$ref": "#/definitions/ConnectionSettingParameter" - } - } - }, - "description": "Properties for a Connection Setting Item" - }, - "ConnectionSetting": { - "type": "object", - "description": "Bot channel resource definition", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ConnectionSettingProperties", - "description": "The set of properties specific to bot channel resource" - } - } - }, - "ConnectionSettingResponseList": { - "properties": { - "nextLink": { - "description": "The link used to get the next page of bot service connection setting resources.", - "type": "string" - }, - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ConnectionSetting" - }, - "description": "Gets the list of bot service connection settings and their properties." - } - }, - "description": "The list of bot service connection settings response." - }, - "ServiceProviderResponseList": { - "properties": { - "nextLink": { - "description": "The link used to get the next page of bot service service providers.", - "type": "string" - }, - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ServiceProvider" - }, - "description": "Gets the list of bot service service providers and their properties." - } - }, - "description": "The list of bot service service providers response." - }, - "ServiceProviderParameter": { - "properties": { - "name": { - "type": "string", - "description": "Name of the Service Provider", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Type of the Service Provider", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Display Name of the Service Provider", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description of the Service Provider", - "readOnly": true - }, - "helpUrl": { - "type": "string", - "description": "Help Url for the Service Provider", - "readOnly": true - }, - "default": { - "type": "string", - "description": "Default Name for the Service Provider", - "readOnly": true - } - }, - "description": "Extra Parameters specific to each Service Provider" - }, - "ServiceProviderProperties": { - "properties": { - "id": { - "type": "string", - "description": "Id for Service Provider", - "readOnly": true - }, - "displayName": { - "type": "string", - "description": "Diplay Name of the Service Provider", - "readOnly": true - }, - "serviceProviderName": { - "type": "string", - "description": "Diplay Name of the Service Provider", - "readOnly": true - }, - "devPortalUrl": { - "type": "string", - "description": "Diplay Name of the Service Provider", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "Diplay Name of the Service Provider", - "readOnly": true - }, - "parameters": { - "description": "The list of parameters for the Service Provider", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceProviderParameter" - } - } - }, - "description": "The Object used to describe a Service Provider supported by Bot Service" - }, - "ServiceProvider": { - "type": "object", - "description": "Service Provider Definition", - "properties": { - "properties": { - "$ref": "#/definitions/ServiceProviderProperties", - "description": "The Properties of a Service Provider Object" - } - } - }, - "Error": { - "properties": { - "error": { - "$ref": "#/definitions/ErrorBody", - "description": "The error body." - } - }, - "description": "Bot Service error object." - }, - "ErrorBody": { - "properties": { - "code": { - "type": "string", - "description": "error code" - }, - "message": { - "type": "string", - "description": "error message" - } - }, - "description": "Bot Service error body.", - "required": [ - "code", - "message" - ] - }, - "OperationEntityListResult": { - "description": "The list of bot service operation response.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - } - } - }, - "OperationEntity": { - "description": "The operations supported by Bot Service Management.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by Bot Service Management." - }, - "origin": { - "description": "The origin of the operation.", - "type": "string" - }, - "properties": { - "description": "Additional properties.", - "type": "object" - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by Bot Service Management.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Microsoft Bot Service.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "CheckNameAvailabilityRequestBody": { - "description": "The request body for a request to Bot Service Management to check availability of a bot name.", - "type": "object", - "properties": { - "name": { - "description": "the name of the bot for which availability needs to be checked.", - "type": "string" - }, - "type": { - "description": "the type of the bot for which availability needs to be checked", - "type": "string" - } - } - }, - "CheckNameAvailabilityResponseBody": { - "description": "The response body returned for a request to Bot Service Management to check availability of a bot name.", - "type": "object", - "properties": { - "valid": { - "description": "indicates if the bot name is valid.", - "type": "boolean" - }, - "message": { - "description": "additional message from the bot management api showing why a bot name is not available", - "type": "string" - } - } - } - }, - "parameters": { - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource group in the user subscription." - }, - "resourceNameParameter": { - "name": "resourceName", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot resource." - }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Azure Subscription ID.", - "required": true, - "type": "string" - }, - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Version of the API to be used with the client request. Current version is 2017-12-01" - }, - "connectionNameParameter": { - "name": "connectionName", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "maxLength": 64, - "minLength": 2, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", - "description": "The name of the Bot Service Connection Setting resource" - }, - "channelNameParameter": { - "name": "channelName", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "FacebookChannel", - "EmailChannel", - "KikChannel", - "TelegramChannel", - "SlackChannel", - "MsTeamsChannel", - "SkypeChannel", - "WebChatChannel", - "DirectLineChannel", - "SmsChannel" - ], - "x-ms-enum": { - "name": "channelName", - "modelAsString": false, - "values": [ - { - "value": "FacebookChannel" - }, - { - "value": "EmailChannel" - }, - { - "value": "KikChannel" - }, - { - "value": "TelegramChannel" - }, - { - "value": "SlackChannel" - }, - { - "value": "MsTeamsChannel" - }, - { - "value": "SkypeChannel" - }, - { - "value": "WebChatChannel" - }, - { - "value": "DirectLineChannel" - }, - { - "value": "SmsChannel" - } - ] - }, - "description": "The name of the Channel resource." - } - } +{ + "swagger": "2.0", + "info": { + "title": "Azure Bot Service", + "description": "Azure Bot Service is a platform for creating smart conversational agents.", + "version": "2017-12-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": { + "put": { + "tags": [ + "Bot" + ], + "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.", + "operationId": "Bots_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/CreateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Bot" + ], + "description": "Updates a Bot Service", + "operationId": "Bots_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Bot" + ], + "description": "Deletes a Bot Service from the resource group. ", + "operationId": "Bots_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Bot" + ], + "description": "Returns a BotService specified by the parameters.", + "operationId": "Bots_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Bots_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListBotsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Bots_List", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/ListBotsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}": { + "put": { + "tags": [ + "Channel" + ], + "description": "Creates a Channel registration for a Bot Service", + "operationId": "Channels_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/PutChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Channel" + ], + "description": "Updates a Channel registration for a Bot Service", + "operationId": "Channels_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Channel" + ], + "description": "Deletes a Channel registration from a Bot Service", + "operationId": "Channels_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Channel" + ], + "description": "Returns a BotService Channel registration specified by the parameters.", + "operationId": "Channels_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys": { + "post": { + "tags": [ + "Channel" + ], + "description": "Lists a Channel registration for a Bot Service including secrets", + "operationId": "Channels_ListWithKeys", + "x-ms-examples": { + "List Channel": { + "$ref": "./examples/ListChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels": { + "get": { + "tags": [ + "Channel" + ], + "description": "Returns all the Channel registrations of a particular BotService resource", + "operationId": "Channels_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListChannelsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ChannelResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BotService/botServices/checkNameAvailability": { + "get": { + "tags": [ + "Bot" + ], + "description": "Check whether a bot name is available.", + "operationId": "Bots_GetCheckNameAvailability", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequestBody" + }, + "description": "The request body parameters to provide for the check name availability request" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponseBody" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.BotService/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available BotService operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders": { + "post": { + "tags": [ + "ListServiceProviders" + ], + "description": "Lists the available Service Providers for creating Connection Settings", + "operationId": "BotConnection_ListServiceProviders", + "x-ms-examples": { + "List Auth Service Providers": { + "$ref": "./examples/ListServiceProviders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ServiceProviderResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets": { + "post": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_ListWithSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}": { + "put": { + "tags": [ + "BotConnection" + ], + "description": "Register a new Auth Connection for a Bot Service", + "operationId": "BotConnection_Create", + "x-ms-examples": { + "Create Connection Setting": { + "$ref": "./examples/PutConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for creating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "BotConnection" + ], + "description": "Updates a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Update", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/UpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for updating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "BotConnection" + ], + "description": "Deletes a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Delete", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/DeleteConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections": { + "get": { + "tags": [ + "BotConnection" + ], + "description": "Returns all the Connection Settings registered to a particular BotService resource", + "operationId": "BotConnection_ListByBotService", + "x-ms-examples": { + "List Connection Settings": { + "$ref": "./examples/ListConnectionsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with \"value\" property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ConnectionSettingResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "Azure resource", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + } + } + }, + "Sku": { + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "The sku name" + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Free", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "SkuName": { + "type": "string", + "description": "The name of SKU.", + "enum": [ + "F0", + "S1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "Kind": { + "type": "string", + "description": "Indicates the type of bot service", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "Bot": { + "type": "object", + "description": "Bot resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BotProperties", + "description": "The set of properties specific to bot resource" + } + } + }, + "BotProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The Name of the bot" + }, + "description": { + "type": "string", + "description": "The description of the bot" + }, + "iconUrl": { + "type": "string", + "description": "The Icon Url of the bot" + }, + "endpoint": { + "type": "string", + "description": "The bot's endpoint" + }, + "endpointVersion": { + "type": "string", + "readOnly": true, + "description": "The bot's endpoint version" + }, + "msaAppId": { + "type": "string", + "description": "Microsoft App Id for the bot" + }, + "configuredChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is configured" + }, + "enabledChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is enabled" + }, + "developerAppInsightKey": { + "type": "string", + "description": "The Application Insights key" + }, + "developerAppInsightsApiKey": { + "type": "string", + "description": "The Application Insights Api Key" + }, + "developerAppInsightsApplicationId": { + "type": "string", + "description": "The Application Insights App Id" + }, + "luisAppIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of LUIS App Ids" + }, + "luisKey": { + "type": "string", + "description": "The LUIS Key" + } + }, + "description": "The parameters to provide for the Bot.", + "required": [ + "displayName", + "endpoint", + "msaAppId" + ] + }, + "BotResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Bot" + }, + "description": "Gets the list of bot service results and their properties." + } + }, + "description": "The list of bot service operation response." + }, + "BotChannel": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/Channel", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "Channel": { + "type": "object", + "description": "Channel definition", + "discriminator": "channelName", + "properties": { + "channelName": { + "type": "string", + "description": "The channel name" + } + }, + "required": [ + "channelName" + ] + }, + "FacebookChannel": { + "type": "object", + "description": "Facebook channel definition", + "x-ms-discriminator-value": "FacebookChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FacebookChannelProperties", + "description": "The set of properties specific to bot facebook channel" + } + } + }, + "FacebookChannelProperties": { + "properties": { + "verifyToken": { + "type": "string", + "readOnly": true, + "description": "Verify token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "pages": { + "type": "array", + "items": { + "$ref": "#/definitions/FacebookPage" + }, + "description": "The list of Facebook pages" + }, + "appId": { + "type": "string", + "description": "Facebook application id" + }, + "appSecret": { + "type": "string", + "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "callbackUrl": { + "type": "string", + "readOnly": true, + "description": "Callback Url" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Facebook channel.", + "required": [ + "appId", + "appSecret", + "isEnabled" + ] + }, + "FacebookPage": { + "properties": { + "id": { + "type": "string", + "description": "Page id" + }, + "accessToken": { + "type": "string", + "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." + } + }, + "description": "A Facebook page for Facebook channel registration", + "required": [ + "id", + "accessToken" + ] + }, + "EmailChannel": { + "type": "object", + "description": "Email channel definition", + "x-ms-discriminator-value": "EmailChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EmailChannelProperties", + "description": "The set of properties specific to email channel resource" + } + } + }, + "EmailChannelProperties": { + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address" + }, + "password": { + "type": "string", + "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Email channel.", + "required": [ + "emailAddress", + "password", + "isEnabled" + ] + }, + "MsTeamsChannel": { + "type": "object", + "x-ms-discriminator-value": "MsTeamsChannel", + "description": "Microsoft Teams channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MsTeamsChannelProperties", + "description": "The set of properties specific to Microsoft Teams channel resource" + } + } + }, + "MsTeamsChannelProperties": { + "properties": { + "enableMessaging": { + "type": "boolean", + "description": "Enable messaging for Microsoft Teams channel" + }, + "enableMediaCards": { + "type": "boolean", + "description": "Enable media cards for Microsoft Teams channel" + }, + "enableVideo": { + "type": "boolean", + "description": "Enable video for Microsoft Teams channel" + }, + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Microsoft Teams channel" + }, + "callMode": { + "type": "string", + "description": "Enable messaging for Microsoft Teams channel" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "SkypeChannel": { + "type": "object", + "description": "Skype channel definition", + "x-ms-discriminator-value": "SkypeChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SkypeChannelProperties", + "description": "The set of properties specific to Skype channel resource" + } + } + }, + "SkypeChannelProperties": { + "properties": { + "enableMessaging": { + "type": "boolean", + "description": "Enable messaging for Skype channel" + }, + "enableMediaCards": { + "type": "boolean", + "description": "Enable media cards for Skype channel" + }, + "enableVideo": { + "type": "boolean", + "description": "Enable video for Skype channel" + }, + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Skype channel" + }, + "enableScreenSharing": { + "type": "boolean", + "description": "Enable screen sharing for Skype channel" + }, + "enableGroups": { + "type": "boolean", + "description": "Enable groups for Skype channel" + }, + "groupsMode": { + "type": "string", + "description": "Group mode for Skype channel" + }, + "callingWebHook": { + "type": "string", + "description": "Calling web hook for Skype channel" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "KikChannel": { + "type": "object", + "x-ms-discriminator-value": "KikChannel", + "description": "Kik channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KikChannelProperties", + "description": "The set of properties specific to Kik channel resource" + } + } + }, + "KikChannelProperties": { + "properties": { + "userName": { + "type": "string", + "description": "The Kik user name" + }, + "apiKey": { + "type": "string", + "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Kik channel.", + "required": [ + "userName", + "apiKey", + "isEnabled" + ] + }, + "WebChatChannel": { + "type": "object", + "x-ms-discriminator-value": "WebChatChannel", + "description": "Web Chat channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebChatChannelProperties", + "description": "The set of properties specific to Web Chat channel resource" + } + } + }, + "WebChatChannelProperties": { + "properties": { + "webChatEmbedCode": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "readOnly": true, + "description": "Web chat control embed code" + }, + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/WebChatSite" + }, + "description": "The list of Web Chat sites" + } + }, + "description": "The parameters to provide for the Web Chat channel." + }, + "DirectLineChannel": { + "type": "object", + "x-ms-discriminator-value": "DirectLineChannel", + "description": "Direct Line channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DirectLineChannelProperties", + "description": "The set of properties specific to Direct Line channel resource" + } + } + }, + "DirectLineChannelProperties": { + "properties": { + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectLineSite" + }, + "description": "The list of Direct Line sites" + } + }, + "description": "The parameters to provide for the Direct Line channel." + }, + "TelegramChannel": { + "type": "object", + "description": "Telegram channel definition", + "x-ms-discriminator-value": "TelegramChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TelegramChannelProperties", + "description": "The set of properties specific to Telegram channel resource" + } + } + }, + "TelegramChannelProperties": { + "properties": { + "accessToken": { + "type": "string", + "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Telegram channel.", + "required": [ + "accessToken", + "isEnabled" + ] + }, + "SmsChannel": { + "type": "object", + "description": "Sms channel definition", + "x-ms-discriminator-value": "SmsChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SmsChannelProperties", + "description": "The set of properties specific to Sms channel resource" + } + } + }, + "SmsChannelProperties": { + "properties": { + "phone": { + "type": "string", + "description": "The Sms phone" + }, + "accountSID": { + "type": "string", + "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "authToken": { + "type": "string", + "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Sms channel.", + "required": [ + "phone", + "accountSID", + "authToken", + "isEnabled" + ] + }, + "SlackChannel": { + "type": "object", + "description": "Slack channel definition", + "x-ms-discriminator-value": "SlackChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SlackChannelProperties", + "description": "The set of properties specific to Slack channel resource" + } + } + }, + "SlackChannelProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "The Slack client id" + }, + "clientSecret": { + "type": "string", + "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "verificationToken": { + "type": "string", + "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "landingPageUrl": { + "type": "string", + "description": "The Slack landing page Url" + }, + "redirectAction": { + "type": "string", + "description": "The Slack redirect action", + "readOnly": true + }, + "lastSubmissionId": { + "type": "string", + "description": "The Sms auth token", + "readOnly": true + }, + "registerBeforeOAuthFlow": { + "type": "boolean", + "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.", + "readOnly": true + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Slack channel.", + "required": [ + "clientId", + "clientSecret", + "verificationToken", + "isEnabled" + ] + }, + "ChannelResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service channel resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/BotChannel" + }, + "description": "Gets the list of bot service channel results and their properties." + } + }, + "description": "The list of bot service channel operation response." + }, + "WebChatSite": { + "properties": { + "siteId": { + "type": "string", + "description": "Site Id", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "key2": { + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel" + }, + "enablePreview": { + "type": "boolean", + "description": "Whether this site is enabled for preview versions of Webchat" + } + }, + "required": [ + "siteName", + "isEnabled", + "enablePreview" + ], + "description": "A site for the Webchat channel" + }, + "DirectLineSite": { + "properties": { + "siteId": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Site Id", + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "key2": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel" + }, + "isV1Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol" + }, + "isV3Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol" + } + }, + "description": "A site for the Direct Line channel", + "required": [ + "isV1Enabled", + "isV3Enabled", + "isEnabled", + "siteName" + ] + }, + "ConnectionItemName": { + "properties": { + "name": { + "type": "string", + "description": "Connection Item name that has been added in the API", + "readOnly": true + } + }, + "description": "The display name of a connection Item Setting registered with the Bot" + }, + "ConnectionSettingParameter": { + "properties": { + "key": { + "type": "string", + "description": "Key for the Connection Setting Parameter." + }, + "value": { + "type": "string", + "description": "Value associated with the Connection Setting Parameter." + } + }, + "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" + }, + "ConnectionSettingProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id associated with the Connection Setting." + }, + "settingId": { + "type": "string", + "description": "Setting Id set by the service for the Connection Setting.", + "readOnly": true + }, + "clientSecret": { + "type": "string", + "description": "Client Secret associated with the Connection Setting" + }, + "scopes": { + "type": "string", + "description": "Scopes associated with the Connection Setting" + }, + "serviceProviderId": { + "type": "string", + "description": "Service Provider Id associated with the Connection Setting" + }, + "serviceProviderDisplayName": { + "type": "string", + "description": "Service Provider Display Name associated with the Connection Setting" + }, + "parameters": { + "type": "array", + "description": "Service Provider Parameters associated with the Connection Setting", + "items": { + "$ref": "#/definitions/ConnectionSettingParameter" + } + } + }, + "description": "Properties for a Connection Setting Item" + }, + "ConnectionSetting": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionSettingProperties", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "ConnectionSettingResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service connection setting resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "Gets the list of bot service connection settings and their properties." + } + }, + "description": "The list of bot service connection settings response." + }, + "ServiceProviderResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service service providers.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProvider" + }, + "description": "Gets the list of bot service service providers and their properties." + } + }, + "description": "The list of bot service service providers response." + }, + "ServiceProviderParameter": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Service Provider", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the Service Provider", + "readOnly": true + }, + "helpUrl": { + "type": "string", + "description": "Help Url for the Service Provider", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default Name for the Service Provider", + "readOnly": true + } + }, + "description": "Extra Parameters specific to each Service Provider" + }, + "ServiceProviderProperties": { + "properties": { + "id": { + "type": "string", + "description": "Id for Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "serviceProviderName": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "devPortalUrl": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "iconUrl": { + "type": "string", + "description": "Diplay Name of the Service Provider", + "readOnly": true + }, + "parameters": { + "description": "The list of parameters for the Service Provider", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProviderParameter" + } + } + }, + "description": "The Object used to describe a Service Provider supported by Bot Service" + }, + "ServiceProvider": { + "type": "object", + "description": "Service Provider Definition", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceProviderProperties", + "description": "The Properties of a Service Provider Object" + } + } + }, + "Error": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody", + "description": "The error body." + } + }, + "description": "Bot Service error object." + }, + "ErrorBody": { + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "description": "Bot Service error body.", + "required": [ + "code", + "message" + ] + }, + "OperationEntityListResult": { + "description": "The list of bot service operation response.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operations supported by Bot Service Management.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Bot Service Management." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Bot Service Management.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft Bot Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequestBody": { + "description": "The request body for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "name": { + "description": "the name of the bot for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "the type of the bot for which availability needs to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponseBody": { + "description": "The response body returned for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "valid": { + "description": "indicates if the bot name is valid.", + "type": "boolean" + }, + "message": { + "description": "additional message from the bot management api showing why a bot name is not available", + "type": "string" + } + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource group in the user subscription." + }, + "resourceNameParameter": { + "name": "resourceName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2017-12-01" + }, + "connectionNameParameter": { + "name": "connectionName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot Service Connection Setting resource" + }, + "channelNameParameter": { + "name": "channelName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel" + ], + "x-ms-enum": { + "name": "channelName", + "modelAsString": false, + "values": [ + { + "value": "FacebookChannel" + }, + { + "value": "EmailChannel" + }, + { + "value": "KikChannel" + }, + { + "value": "TelegramChannel" + }, + { + "value": "SlackChannel" + }, + { + "value": "MsTeamsChannel" + }, + { + "value": "SkypeChannel" + }, + { + "value": "WebChatChannel" + }, + { + "value": "DirectLineChannel" + }, + { + "value": "SmsChannel" + } + ] + }, + "description": "The name of the Channel resource." + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json index 05eeacdb11a0..76879ee47152 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CheckNameAvailability.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "api-version": "2017-01-01", - "parameters": { - "name": "testbotname", - "type": "string" - } - }, - "responses": { - "200": { - "body": { - "valid": true, - "message": "custom message from server" - } - } - } +{ + "parameters": { + "api-version": "2017-01-01", + "parameters": { + "name": "testbotname", + "type": "string" + } + }, + "responses": { + "200": { + "body": { + "valid": true, + "message": "custom message from server" + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json index ca7264389dba..93aef41e70a4 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/CreateBot.json @@ -1,108 +1,108 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "resourceGroupName": "OneResourceGroupName", - "api-version": "2017-01-01", - "resourceName": "samplebotname", - "parameters": { - "location": "West US", - "sku": { - "name": "S1" - }, - "etag": "etag1", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApiKey": "appinsightsapikey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "luisKey": "luiskey", - "msaAppId": "exampleappid" - } - } - }, - "responses": { - "200": { - "body": { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "etag": "etag1", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - }, - "201": { - "body": { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "properties": { - "description": "The description of the bot", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "parameters": { + "location": "West US", + "sku": { + "name": "S1" + }, + "etag": "etag1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApiKey": "appinsightsapikey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "luisKey": "luiskey", + "msaAppId": "exampleappid" + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + }, + "201": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json index 4f4cc4849fee..08b09eeb7aaa 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/DeleteBot.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "resourceGroupName": "OneResourceGroupName", - "api-version": "2017-01-01", - "resourceName": "samplebotname" - }, - "responses": { - "200": { - }, - "204": { - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname" + }, + "responses": { + "200": { + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json index 6d2cc80e2c4d..2a350bd44f8c 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetBot.json @@ -1,45 +1,45 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "resourceGroupName": "OneResourceGroupName", - "api-version": "2017-01-01", - "resourceName": "samplebotname" - }, - "responses": { - "200": { - "body": { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "etag": "etag1", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname" + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json index b739087bd811..1f4b66c26e48 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/GetOperations.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "api-version": "2017-04-18" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.BotService/botService/read", - "display": { - "provider": "Microsoft Bot Service", - "resource": "Bot Service", - "operation": "Read Bot Service", - "description": "Read Bot Service" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BotService/botService/write", - "display": { - "provider": "Microsoft Bot Service", - "resource": "Bot Service", - "operation": "Write Bot Service", - "description": "Writes Bot Service" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BotService/botService/delete", - "display": { - "provider": "Microsoft Bot Service", - "resource": "Bot Service", - "operation": "Delete Bot Service", - "description": "Deletes Bot Service" - }, - "origin": "user,system" - }, - { - "name": "Microsoft.BotService/botService/botName/read", - "display": { - "provider": "Microsoft Bot Service", - "resource": "Bot Service name availability", - "operation": "Check bot name availability", - "description": "Check bot name availability" - }, - "origin": "user,system" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2017-04-18" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.BotService/botService/read", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Read Bot Service", + "description": "Read Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/write", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Write Bot Service", + "description": "Writes Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/delete", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Delete Bot Service", + "description": "Deletes Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/botName/read", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service name availability", + "operation": "Check bot name availability", + "description": "Check bot name availability" + }, + "origin": "user,system" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json index 0d1395376e2f..848588797bff 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsByResourceGroup.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "resourceGroupName": "OneResourceGroupName", - "api-version": "2017-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "etag": "etag1", - "kind": "sdk", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "etag": "etag1", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json index 3f569adada26..d67462778e86 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/ListBotsBySubscription.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "api-version": "2017-01-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "etag": "etag1", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "api-version": "2017-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json index bb004dea1755..350fb4b8dd25 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/examples/UpdateBot.json @@ -1,110 +1,110 @@ -{ - "parameters": { - "subscriptionId": "subscription-id", - "resourceGroupName": "OneResourceGroupName", - "api-version": "2017-01-01", - "resourceName": "samplebotname", - "parameters": { - "location": "West US", - "sku": { - "name": "S1" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "etag": "etag1", - "name": "samplename", - "type": "sampletype", - "kind": "sdk", - "id": "someid", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApiKey": "appinsightsapikey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "luisKey": "luiskey", - "msaAppId": "msaappid" - } - } - }, - "responses": { - "200": { - "body": { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "etag": "etag1", - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - }, - "201": { - "body": { - "location": "West US", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "name": "samplename", - "type": "sampletype", - "id": "someid", - "kind": "sdk", - "etag": "etag1", - "properties": { - "description": "The description of the bot", - "developerAppInsightKey": "appinsightskey", - "developerAppInsightsApplicationId": "appinsightsappid", - "displayName": "The Name of the bot", - "endpoint": "http://mybot.coffee", - "endpointVersion": "version", - "iconUrl": "http://myicon", - "luisAppIds": [ - "luisappid1", - "luisappid2" - ], - "msaAppId": "msaappid", - "configuredChannels": [ - "facebook", - "groupme" - ], - "enabledChannels": [ - "facebook" - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2017-01-01", + "resourceName": "samplebotname", + "parameters": { + "location": "West US", + "sku": { + "name": "S1" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "etag": "etag1", + "name": "samplename", + "type": "sampletype", + "kind": "sdk", + "id": "someid", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApiKey": "appinsightsapikey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "luisKey": "luiskey", + "msaAppId": "msaappid" + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "etag": "etag1", + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + }, + "201": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplename", + "type": "sampletype", + "id": "someid", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/CreateBot.json index 114767633d30..93aef41e70a4 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/CreateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/CreateBot.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscription-id", "resourceGroupName": "OneResourceGroupName", diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/DeleteBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/DeleteBot.json index e7397175954b..08b09eeb7aaa 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/DeleteBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/DeleteBot.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscription-id", "resourceGroupName": "OneResourceGroupName", diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/GetOperations.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/GetOperations.json index a7dd6169b072..1f4b66c26e48 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/GetOperations.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-04-18" }, diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsByResourceGroup.json index 9e5efe73976b..848588797bff 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsByResourceGroup.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsByResourceGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscription-id", "resourceGroupName": "OneResourceGroupName", diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsBySubscription.json index a9bccc87b994..d67462778e86 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsBySubscription.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/ListBotsBySubscription.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscription-id", "api-version": "2017-01-01" diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/UpdateBot.json index 38dca2a0eafd..350fb4b8dd25 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/UpdateBot.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/examples/UpdateBot.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscription-id", "resourceGroupName": "OneResourceGroupName", diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CheckNameAvailabilityWithSubscription.json index e8e0fd8de78e..0d0ffd14eb8d 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CheckNameAvailabilityWithSubscription.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CheckNameAvailabilityWithSubscription.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "api-version": "2017-10-12", - "subscriptionId": "subid", - "checkNameAvailabilityInput": { - "name": "sampleName", - "type": "Microsoft.Cdn/Profiles/Endpoints" - } - }, - "responses": { - "200": { - "body": { - "nameAvailable": false, - "reason": "Name is already in use", - "message": "Name not available" - } - } - } +{ + "parameters": { + "api-version": "2017-10-12", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json index 7c7350b1c365..0ffeeb3dbdef 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/stable/v2.0/examples/SuccessfulEntitiesRequest.json @@ -1,96 +1,96 @@ -{ - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "Endpoint": "{Endpoint}", - "input": { - "documents": [ - { - "language": "en", - "id": "1", - "text": "Microsoft released Windows 10" - }, - { - "language": "en", - "id": "2", - "text": "In 1975, Bill Gates III and Paul Allen founded the company." - } - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "documents": [ - { - "id": "1", - "entities": [ - { - "name": "Windows 10", - "matches": [ - { - "text": "Windows 10", - "offset": 19, - "length": 10 - } - ], - "wikipediaLanguage": "en", - "wikipediaId": "Windows 10", - "wikipediaUrl": "https://en.wikipedia.org/wiki/Windows_10", - "bingId": "5f9fbd03-49c4-39ef-cc95-de83ab897b94" - }, - { - "name": "Microsoft", - "matches": [ - { - "text": "Microsoft", - "offset": 0, - "length": 9 - } - ], - "wikipediaLanguage": "en", - "wikipediaId": "Microsoft", - "wikipediaUrl": "https://en.wikipedia.org/wiki/Microsoft", - "bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85" - } - ] - }, - { - "id": "2", - "entities": [ - { - "name": "Bill Gates", - "matches": [ - { - "text": "Bill Gates III", - "offset": 9, - "length": 14 - } - ], - "wikipediaLanguage": "en", - "wikipediaId": "Bill Gates", - "wikipediaUrl": "https://en.wikipedia.org/wiki/Bill_Gates", - "bingId": "0d47c987-0042-5576-15e8-97af601614fa" - }, - { - "name": "Paul Allen", - "matches": [ - { - "text": "Paul Allen", - "offset": 28, - "length": 10 - } - ], - "wikipediaLanguage": "en", - "wikipediaId": "Paul Allen", - "wikipediaUrl": "https://en.wikipedia.org/wiki/Paul_Allen", - "bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7" - } - ] - } - ], - "errors": [] - } - } - } -} +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "input": { + "documents": [ + { + "language": "en", + "id": "1", + "text": "Microsoft released Windows 10" + }, + { + "language": "en", + "id": "2", + "text": "In 1975, Bill Gates III and Paul Allen founded the company." + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "documents": [ + { + "id": "1", + "entities": [ + { + "name": "Windows 10", + "matches": [ + { + "text": "Windows 10", + "offset": 19, + "length": 10 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Windows 10", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Windows_10", + "bingId": "5f9fbd03-49c4-39ef-cc95-de83ab897b94" + }, + { + "name": "Microsoft", + "matches": [ + { + "text": "Microsoft", + "offset": 0, + "length": 9 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Microsoft", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Microsoft", + "bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85" + } + ] + }, + { + "id": "2", + "entities": [ + { + "name": "Bill Gates", + "matches": [ + { + "text": "Bill Gates III", + "offset": 9, + "length": 14 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Bill Gates", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Bill_Gates", + "bingId": "0d47c987-0042-5576-15e8-97af601614fa" + }, + { + "name": "Paul Allen", + "matches": [ + { + "text": "Paul Allen", + "offset": 28, + "length": 10 + } + ], + "wikipediaLanguage": "en", + "wikipediaId": "Paul Allen", + "wikipediaUrl": "https://en.wikipedia.org/wiki/Paul_Allen", + "bingId": "df2c4376-9923-6a54-893f-2ee5a5badbc7" + } + ] + } + ], + "errors": [] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromABlob.json index a91e59e1203a..f9cfdaa2a028 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromABlob.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAManagedDisk.json index 4c821ef7a3e5..30180eeafb55 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAManagedDisk.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromASnapshot.json index eee1ced5108d..c837a5c87cff 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromASnapshot.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAVM.json index 957e75381d5d..7f5289e7d5b8 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAVM.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageFromAVM.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "sourceVirtualMachine": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "sourceVirtualMachine": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" - }, - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "managedDisk": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" - }, - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromABlob.json index b22592015748..a1315844c42d 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" - } - ] - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json index 392185259e2e..8fd1c55f3f51 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json index 95e57ce8e39c..a0ee9f92aece 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - } - } - ] - } - } - } - }, - "responses": { - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAManagedDisk.json index a33ecb461590..ca4a439287cd 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAManagedDisk.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-03-30", - "diskName": "myManagedDisk" - }, - "responses": { - "200": { - "body": { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Empty" - }, - "diskSizeGB": 10, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:41:35.079872+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/disks", - "location": "westus", - "tags": { - "department": "Development", - "project": "ManagedDisks" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", - "name": "myManagedDisk" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-03-30", + "diskName": "myManagedDisk" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutASnapshot.json index 338c5f8b9c55..df0769cc64a1 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutASnapshot.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "snapshotName": "mySnapshot" - }, - "responses": { - "200": { - "body": { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Empty" - }, - "diskSizeGB": 100, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:41:35.079872+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/snapshots", - "location": "westus", - "tags": { - "department": "Development", - "project": "Snapshots" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", - "name": "mySnapshot" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "snapshotName": "mySnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 100, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAnImage.json index ef9dd8981da4..273531c2c600 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAnImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/GetInformationAboutAnImage.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview", - "imageName": "myImage" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized", - "diskSizeGB": 20 - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "created" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInAResourceGroup.json index 3165270a5a4f..4676396aa847 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInAResourceGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInAResourceGroup.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "created" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInASubscription.json index 5902828ef1c8..1cfdd8a13b6f 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListImagesInASubscription.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "api-version": "2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "created" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInAResourceGroup.json index b011600abfbe..c7edaaebd835 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInAResourceGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInAResourceGroup.json @@ -1,103 +1,103 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Copy", - "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "diskSizeGB": 200, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:41:35.9278721+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/disks", - "location": "westus", - "tags": { - "department": "Development", - "project": "ManagedDisks" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", - "name": "myManagedDisk" - }, - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Empty" - }, - "diskSizeGB": 10, - "timeCreated": "2016-12-28T04:41:36.872242+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/disks", - "location": "westus", - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", - "name": "myManagedDisk" - }, - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "FromImage", - "imageReference": { - "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" - } - }, - "diskSizeGB": 200, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:41:36.3973934+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/disks", - "location": "westus", - "tags": { - "department": "Development", - "project": "ManagedDisks" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", - "name": "myManagedDisk" - } - ], - "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskSizeGB": 200, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInASubscription.json index 9dab9f70ac61..09cb19489e47 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListManagedDisksInASubscription.json @@ -1,102 +1,102 @@ -{ - "parameters": { - "subscriptionId":"{subscription-id}", - "api-version":"2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "osType":"Windows", - "creationData": { - "createOption":"Copy", - "sourceResourceId":"subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "diskSizeGB":200, - "encryptionSettings": { - "enabled":true, - "diskEncryptionKey": { - "sourceVault": { - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl":"https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl":"https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated":"2016-12-28T04:41:35.9278721+00:00", - "provisioningState":"Succeeded" - }, - "type":"Microsoft.Compute/disks", - "location":"westus", - "tags": { - "department":"Development", - "project":"ManagedDisks" - }, - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", - "name":"myManagedDisk1" - }, - { - "properties": { - "osType":"Windows", - "creationData": { - "createOption":"Empty" - }, - "diskSizeGB":10, - "timeCreated":"2016-12-28T04:41:36.872242+00:00", - "provisioningState":"Succeeded" - }, - "type":"Microsoft.Compute/disks", - "location":"westus", - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", - "name":"myManagedDisk2" - }, - { - "properties": { - "osType":"Windows", - "creationData": { - "createOption":"FromImage", - "imageReference": { - "id":"/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" - } - }, - "diskSizeGB":200, - "encryptionSettings": { - "enabled":true, - "diskEncryptionKey": { - "sourceVault": { - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl":"https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl":"https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated":"2016-12-28T04:41:36.3973934+00:00", - "provisioningState":"Succeeded" - }, - "type":"Microsoft.Compute/disks", - "location":"westus", - "tags": { - "department":"Development", - "project":"ManagedDisks" - }, - "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", - "name":"myManagedDisk3" - } - ], - "nextLink":"http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" - } - } - } +{ + "parameters": { + "subscriptionId":"{subscription-id}", + "api-version":"2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType":"Windows", + "creationData": { + "createOption":"Copy", + "sourceResourceId":"subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "diskSizeGB":200, + "encryptionSettings": { + "enabled":true, + "diskEncryptionKey": { + "sourceVault": { + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl":"https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl":"https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated":"2016-12-28T04:41:35.9278721+00:00", + "provisioningState":"Succeeded" + }, + "type":"Microsoft.Compute/disks", + "location":"westus", + "tags": { + "department":"Development", + "project":"ManagedDisks" + }, + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", + "name":"myManagedDisk1" + }, + { + "properties": { + "osType":"Windows", + "creationData": { + "createOption":"Empty" + }, + "diskSizeGB":10, + "timeCreated":"2016-12-28T04:41:36.872242+00:00", + "provisioningState":"Succeeded" + }, + "type":"Microsoft.Compute/disks", + "location":"westus", + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", + "name":"myManagedDisk2" + }, + { + "properties": { + "osType":"Windows", + "creationData": { + "createOption":"FromImage", + "imageReference": { + "id":"/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB":200, + "encryptionSettings": { + "enabled":true, + "diskEncryptionKey": { + "sourceVault": { + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl":"https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl":"https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated":"2016-12-28T04:41:36.3973934+00:00", + "provisioningState":"Succeeded" + }, + "type":"Microsoft.Compute/disks", + "location":"westus", + "tags": { + "department":"Development", + "project":"ManagedDisks" + }, + "id":"/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", + "name":"myManagedDisk3" + } + ], + "nextLink":"http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInAResourceGroup.json index ae6d17eeaf7d..baca0e114e61 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInAResourceGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInAResourceGroup.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Copy", - "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "diskSizeGB": 200, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:41:35.9278721+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/snapshots", - "location": "westus", - "tags": { - "department": "Development", - "project": "Snapshots" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", - "name": "mySnapshot" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInASubscription.json index 04c5f597ba39..98ec1f8e3ee5 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/examples/ListSnapshotsInASubscription.json @@ -1,85 +1,85 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "api-version": "2016-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Copy", - "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "diskSizeGB": 200, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:47:30.6630569+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/snapshots", - "location": "westus", - "tags": { - "department": "Development", - "project": "Snapshots" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", - "name": "mySnapshot1" - }, - { - "properties": { - "osType": "Windows", - "creationData": { - "createOption": "Import", - "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", - "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" - }, - "diskSizeGB": 200, - "encryptionSettings": { - "enabled": true, - "diskEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" - }, - "keyEncryptionKey": { - "sourceVault": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" - }, - "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" - } - }, - "timeCreated": "2016-12-28T04:47:30.3247198+00:00", - "provisioningState": "Succeeded" - }, - "type": "Microsoft.Compute/snapshots", - "location": "westus", - "tags": { - "department": "Development", - "project": "Snapshots" - }, - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", - "name": "mySnapshot2" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2016-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:47:30.6630569+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "name": "mySnapshot1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 200, + "encryptionSettings": { + "enabled": true, + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "timeCreated": "2016-12-28T04:47:30.3247198+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json index 29daa64431b2..053c6d05f092 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -1,146 +1,146 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "{vm-name}", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" - }, - "osType": "Windows", - "createOption": "FromImage", - "caching": "ReadWrite", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" - } - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - } - }, - "dataDisks": [] - }, - "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - } - }, - "dataDisks": [] - }, - "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json index ab18cb903403..61b31b36a345 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -1,145 +1,145 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "osDisk", - "vhdContainers": [ - "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" - ] - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "vhdContainers": [ - "http://{existing-storage-account-name}.blob.core.windows.net/vhds" - ], - "name": "osDisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json index cb7ee15d5dde..5c0dbdd7291b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -1,214 +1,214 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "{vm-name}", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0, - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" - } - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1, - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "name": "dataDisk0", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" - }, - "lun": 0 - }, - { - "name": "dataDisk1", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" - }, - "lun": 1 - } - ] - }, - "vmId": "5230a749-2f68-4830-900b-702182d32e63", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "name": "dataDisk0", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" - }, - "lun": 0 - }, - { - "name": "dataDisk1", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" - }, - "lun": 1 - } - ] - }, - "vmId": "5230a749-2f68-4830-900b-702182d32e63", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetFromACustomImage.json index d62c0a0751bf..8f321d125fba 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetFromACustomImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetFromACustomImage.json @@ -1,132 +1,132 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAMarketplaceImagePlan.json index 5a32b449be1a..824527c74cef 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAMarketplaceImagePlan.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -1,149 +1,149 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "windows2016", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "windows-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - }, - "plan": { - "publisher": "microsoft-ads", - "product": "windows-data-science-vm", - "name": "windows2016" - }, - "location": "westus" - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachineScaleSets", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureApplicationGateway.json index 5eb48016c5cd..9d2089201e4d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureApplicationGateway.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -1,149 +1,149 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" - } - ], - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" - } - ], - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureLoadBalancer.json index 374a5e4619a8..c3b831146c0f 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureLoadBalancer.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -1,159 +1,159 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - }, - "loadBalancerInboundNatPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" - } - ] - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "loadBalancerInboundNatPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" - } - ], - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithBootDiagnostics.json index c7e6a93d3d4a..8981af240044 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithBootDiagnostics.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithBootDiagnostics.json @@ -1,151 +1,151 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", - "enabled": true - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json index a4b8e04c5643..7195a3f27106 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -1,171 +1,171 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D2_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0 - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D2_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPasswordAuthentication.json index 98ab8dc85639..07d08d005f26 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPasswordAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -1,139 +1,139 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPremiumStorage.json index 30a0f31dfb80..31154933a966 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPremiumStorage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithPremiumStorage.json @@ -1,139 +1,139 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_DS1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithSshAuthentication.json index 943f493879dc..9e14df45aead 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithSshAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAScaleSetWithSshAuthentication.json @@ -1,156 +1,156 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-03-30", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-03-30", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmFromACustomImage.json index fd666054f4f6..3b702b136ec3 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmFromACustomImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmFromACustomImage.json @@ -1,145 +1,145 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "name": "myVMosdisk", - "diskSizeGB": 30, - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Linux" - }, - "dataDisks": [] - }, - "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "name": "myVMosdisk", - "diskSizeGB": 30, - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Linux" - }, - "dataDisks": [] - }, - "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmInAnAvailabilitySet.json index 14b2fb3b0a88..aec64b17b53d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmInAnAvailabilitySet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmInAnAvailabilitySet.json @@ -1,163 +1,163 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithAMarketplaceImagePlan.json index b1cf8ac9704d..5aa553945a7d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithAMarketplaceImagePlan.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -1,169 +1,169 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "plan": { - "publisher": "microsoft-ads", - "product": "windows-data-science-vm", - "name": "windows2016" - }, - "name": "myVM", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "windows2016", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "windows-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "name": "myVM", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachines", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "location": "westus" - } - }, - "201": { - "body": { - "name": "myVM", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachines", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "name": "myVM", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithBootDiagnostics.json index dbb259333c63..17a71c772c67 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithBootDiagnostics.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithBootDiagnostics.json @@ -1,172 +1,172 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", - "enabled": true - } - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithEmptyDataDisks.json index 51bec3b7f0dc..f2ab3afe5612 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithEmptyDataDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithEmptyDataDisks.json @@ -1,204 +1,204 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0 - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1 - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPasswordAuthentication.json index 388812813aef..9e65a5f9d355 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPasswordAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPasswordAuthentication.json @@ -1,154 +1,154 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPremiumStorage.json index 9b37631f8eaa..f68bbe09816c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPremiumStorage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithPremiumStorage.json @@ -1,154 +1,154 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Premium_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "a149cd25-409f-41af-8088-275f5486bc93", - "hardwareProfile": { - "vmSize": "Standard_DS1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Premium_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "a149cd25-409f-41af-8088-275f5486bc93", - "hardwareProfile": { - "vmSize": "Standard_DS1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithSshAuthentication.json index f61ddc1b2a11..e5182120f538 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithSshAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAVmWithSshAuthentication.json @@ -1,178 +1,178 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-03-30", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "{image_sku}", - "publisher": "{image_publisher}", - "version": "latest", - "offer": "{image_offer}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "osType": "Linux", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "osType": "Linux", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-03-30", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAnAvailabilitySet.json index 1d6fb02c5ded..437c1f8ab5ae 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAnAvailabilitySet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/CreateAnAvailabilitySet.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-03-30", - "availabilitySetName": "myAvailabilitySet", - "parameters": { - "location": "westus", - "properties": { - "platformFaultDomainCount": 2, - "platformUpdateDomainCount": 20 - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "name": "Classic" - }, - "name": "myAvailabilitySet", - "properties": { - "platformFaultDomainCount": 2, - "platformUpdateDomainCount": 20 - }, - "location": "westus", - "type": "Microsoft.Compute/availabilitySets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-03-30", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json index 3268f2b314de..7fc99c5727ae 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -1,146 +1,146 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "{vm-name}", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" - }, - "osType": "Windows", - "createOption": "FromImage", - "caching": "ReadWrite", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" - } - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - } - }, - "dataDisks": [] - }, - "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "osDisk": { - "name": "myVMosdisk", - "image": { - "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - } - }, - "dataDisks": [] - }, - "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json index 8b121b080c5c..477271ee7f97 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -1,222 +1,222 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "osDisk", - "vhdContainers": [ - "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", - "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" - ] - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "vhdContainers": [ - "http://{existing-storage-account-name}.blob.core.windows.net/vhds" - ], - "name": "osDisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "vhdContainers": [ - "http://{existing-storage-account-name}.blob.core.windows.net/vhds" - ], - "name": "osDisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json index 04a5a728837f..becc019a8fef 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -1,214 +1,214 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "{vm-name}", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0, - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" - } - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1, - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "name": "dataDisk0", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" - }, - "lun": 0 - }, - { - "name": "dataDisk1", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" - }, - "lun": 1 - } - ] - }, - "vmId": "5230a749-2f68-4830-900b-702182d32e63", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" - }, - "createOption": "FromImage", - "name": "myVMosdisk", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "name": "dataDisk0", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" - }, - "lun": 0 - }, - { - "name": "dataDisk1", - "diskSizeGB": 1023, - "createOption": "Empty", - "caching": "None", - "vhd": { - "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" - }, - "lun": 1 - } - ] - }, - "vmId": "5230a749-2f68-4830-900b-702182d32e63", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetFromACustomImage.json index 5fec8e107291..c7e1dc2f167c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetFromACustomImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetFromACustomImage.json @@ -1,204 +1,204 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json index de81027d76d5..36e6b8084b15 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -1,230 +1,230 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "windows2016", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "windows-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - }, - "plan": { - "publisher": "microsoft-ads", - "product": "windows-data-science-vm", - "name": "windows2016" - }, - "location": "westus" - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachineScaleSets", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachineScaleSets", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json index 6f907a065d0e..24c4d8c35c85 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -1,230 +1,230 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" - } - ], - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" - } - ], - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "applicationGatewayBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" - } - ], - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json index dd51f25fa77f..0faeb3c42731 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -1,245 +1,245 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - }, - "loadBalancerInboundNatPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" - } - ] - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "loadBalancerInboundNatPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" - } - ], - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "loadBalancerInboundNatPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" - } - ], - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" - } - ], - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithBootDiagnostics.json index c14bdd01d813..4a31d9425386 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithBootDiagnostics.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -1,233 +1,233 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", - "enabled": true - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json index 17cd7de3ad7f..3c1c117c59a3 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -1,267 +1,267 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D2_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0 - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D2_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D2_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPasswordAuthentication.json index c0b4ebde423c..78a2a34ac36c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPasswordAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -1,215 +1,215 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPremiumStorage.json index e424675e20a5..50626139780c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPremiumStorage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -1,215 +1,215 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_DS1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_DS1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithSshAuthentication.json index c39b178384de..fcdf824e6e7b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithSshAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -1,239 +1,239 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2017-12-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "location": "westus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - } - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 3, - "name": "Standard_D1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": true, - "overprovision": true, - "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage" - } - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Manual" - }, - "provisioningState": "Creating" - }, - "location": "westus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2017-12-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmFromACustomImage.json index cbf979875de1..0aec04501d1e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmFromACustomImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmFromACustomImage.json @@ -1,145 +1,145 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "name": "myVMosdisk", - "diskSizeGB": 30, - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Linux" - }, - "dataDisks": [] - }, - "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "disablePasswordAuthentication": false - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" - }, - "osDisk": { - "name": "myVMosdisk", - "diskSizeGB": 30, - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "caching": "ReadWrite", - "createOption": "FromImage", - "osType": "Linux" - }, - "dataDisks": [] - }, - "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmInAnAvailabilitySet.json index 11e9fe2d4063..fd66711a71c1 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmInAnAvailabilitySet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmInAnAvailabilitySet.json @@ -1,163 +1,163 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "availabilitySet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithAMarketplaceImagePlan.json index c1357cd04883..41bf7f06d16e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithAMarketplaceImagePlan.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -1,169 +1,169 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "plan": { - "publisher": "microsoft-ads", - "product": "windows-data-science-vm", - "name": "windows2016" - }, - "name": "myVM", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "windows2016", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "windows-data-science-vm" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "name": "myVM", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachines", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "location": "westus" - } - }, - "201": { - "body": { - "name": "myVM", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "standard-data-science-vm", - "publisher": "microsoft-ads", - "version": "latest", - "offer": "standard-data-science-vm" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "plan": { - "publisher": "microsoft-ads", - "product": "standard-data-science-vm", - "name": "standard-data-science-vm" - }, - "type": "Microsoft.Compute/virtualMachines", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "name": "myVM", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithBootDiagnostics.json index 2a8154339660..c7dec4a7325e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithBootDiagnostics.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithBootDiagnostics.json @@ -1,172 +1,172 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", - "enabled": true - } - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "diagnosticsProfile": { - "bootDiagnostics": { - "storageUri": "http://nsgdiagnostic.blob.core.windows.net", - "enabled": true - } - }, - "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithEmptyDataDisks.json index 4f7e355c340e..3e82199880af 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithEmptyDataDisks.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithEmptyDataDisks.json @@ -1,204 +1,204 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0 - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1 - } - ] - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", - "hardwareProfile": { - "vmSize": "Standard_D2_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPasswordAuthentication.json index 6390f1274ceb..a1bae28f04ed 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPasswordAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPasswordAuthentication.json @@ -1,154 +1,154 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPremiumStorage.json index e4f714844d08..38bca9ecbe98 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPremiumStorage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithPremiumStorage.json @@ -1,154 +1,154 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Premium_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Premium_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "a149cd25-409f-41af-8088-275f5486bc93", - "hardwareProfile": { - "vmSize": "Standard_DS1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "osType": "Windows", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Premium_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "a149cd25-409f-41af-8088-275f5486bc93", - "hardwareProfile": { - "vmSize": "Standard_DS1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithSshAuthentication.json index 25f0207bd40f..6a9b0daee851 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithSshAuthentication.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAVmWithSshAuthentication.json @@ -1,178 +1,178 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmName": "myVM", - "api-version": "2017-12-01", - "parameters": { - "location": "westus", - "properties": { - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "storageProfile": { - "imageReference": { - "sku": "{image_sku}", - "publisher": "{image_publisher}", - "version": "latest", - "offer": "{image_offer}" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "name": "myVMosdisk", - "createOption": "FromImage" - } - }, - "osProfile": { - "adminUsername": "{your-username}", - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", - "properties": { - "primary": true - } - } - ] - } - }, - "name": "myVM" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "osType": "Linux", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", - "type": "Microsoft.Compute/virtualMachines", - "properties": { - "osProfile": { - "adminUsername": "{your-username}", - "secrets": [], - "computerName": "myVM", - "linuxConfiguration": { - "ssh": { - "publicKeys": [ - { - "path": "/home/{your-username}/.ssh/authorized_keys", - "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" - } - ] - }, - "disablePasswordAuthentication": true - } - }, - "networkProfile": { - "networkInterfaces": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", - "properties": { - "primary": true - } - } - ] - }, - "storageProfile": { - "imageReference": { - "sku": "16.04-LTS", - "publisher": "Canonical", - "version": "latest", - "offer": "UbuntuServer" - }, - "osDisk": { - "osType": "Linux", - "caching": "ReadWrite", - "createOption": "FromImage", - "name": "myVMosdisk", - "managedDisk": { - "storageAccountType": "Standard_LRS" - } - }, - "dataDisks": [] - }, - "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", - "hardwareProfile": { - "vmSize": "Standard_D1_v2" - }, - "provisioningState": "Creating" - }, - "name": "myVM", - "location": "westus" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2017-12-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + }, + "name": "myVM" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnAvailabilitySet.json index 4c68a0394192..b2faf50cbe2a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnAvailabilitySet.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnAvailabilitySet.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "availabilitySetName": "myAvailabilitySet", - "parameters": { - "location": "westus", - "properties": { - "platformFaultDomainCount": 2, - "platformUpdateDomainCount": 20 - } - } - }, - "responses": { - "200": { - "body": { - "sku": { - "name": "Classic" - }, - "name": "myAvailabilitySet", - "properties": { - "platformFaultDomainCount": 2, - "platformUpdateDomainCount": 20 - }, - "location": "westus", - "type": "Microsoft.Compute/availabilitySets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromABlob.json index 14c675a032ac..b902b5829677 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromABlob.json @@ -1,62 +1,62 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAManagedDisk.json index 3c108ca436ee..cb23cf2ac04a 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAManagedDisk.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromASnapshot.json index 565c152665e2..0cc87e86a313 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromASnapshot.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized" - } - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAVM.json index 8aeebcffa196..84f9c61f0a6d 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAVM.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageFromAVM.json @@ -1,68 +1,68 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "sourceVirtualMachine": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "sourceVirtualMachine": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" - }, - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "managedDisk": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" - }, - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "sourceVirtualMachine": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" - }, - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "managedDisk": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" - }, - "caching": "ReadWrite" - }, - "dataDisks": [] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json index 7da6afa94be0..0fa483b5babe 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -1,78 +1,78 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "osState": "Generalized", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json index 9fc82fdfc448..cccf0d0dc666 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -1,90 +1,90 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "managedDisk": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json index 919688f2067d..bb0bfa07316b 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -1,90 +1,90 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage", - "parameters": { - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized" - }, - "dataDisks": [ - { - "lun": 1, - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - }, - "201": { - "body": { - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Linux", - "snapshot": { - "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" - }, - "osState": "Generalized", - "caching": "ReadWrite" - }, - "dataDisks": [ - { - "lun": 1, - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - } - } - ] - }, - "provisioningState": "Creating" - }, - "type": "Microsoft.Compute/images", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", - "name": "myImage" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/GetInformationAboutAnImage.json index 268250d763fe..7666a0857c0b 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/GetInformationAboutAnImage.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/GetInformationAboutAnImage.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01", - "imageName": "myImage" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized", - "storageAccountType": "Standard_LRS", - "diskSizeGB": 20 - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - }, - "storageAccountType": "Standard_LRS" - } - ] - }, - "provisioningState": "created" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInAResourceGroup.json index 99847b5a2354..4ccef25126de 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInAResourceGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInAResourceGroup.json @@ -1,51 +1,51 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2017-12-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized", - "storageAccountType": "Standard_LRS" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - }, - "storageAccountType": "Standard_LRS" - } - ] - }, - "provisioningState": "created" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInASubscription.json index 2770941a1bed..2ac83072ed92 100755 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListImagesInASubscription.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "api-version": "2017-12-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", - "name": "myImage", - "type": "Microsoft.Compute/images", - "location": "West US", - "properties": { - "storageProfile": { - "osDisk": { - "osType": "Windows", - "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" - }, - "osState": "Generalized", - "storageAccountType": "Standard_LRS" - }, - "dataDisks": [ - { - "lun": 1, - "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", - "snapshot": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" - }, - "managedDisk": { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" - }, - "storageAccountType": "Standard_LRS" - } - ] - }, - "provisioningState": "created" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2017-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json index b3e37129623e..1859c1918cf7 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/CreateAScaleSetWithVMsInDifferentZones.json @@ -1,284 +1,284 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "vmScaleSetName": "{vmss-name}", - "api-version": "2018-04-01", - "parameters": { - "sku": { - "tier": "Standard", - "capacity": 2, - "name": "Standard_A1_v2" - }, - "location": "centralus", - "properties": { - "overprovision": true, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage", - "diskSizeGB": 512 - }, - "dataDisks": [ - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 0 - }, - { - "diskSizeGB": 1023, - "createOption": "Empty", - "lun": 1 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "adminPassword": "{your-password}" - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" - } - } - } - ] - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Automatic" - } - }, - "zones": [ - "1", - "3" - ] - } - }, - "responses": { - "200": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 2, - "name": "Standard_A1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": false, - "overprovision": true, - "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", - "zoneBalance": false, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage", - "diskSizeGB": 512 - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Automatic" - }, - "provisioningState": "Succeeded" - }, - "zones": [ - "1", - "3" - ], - "location": "centralus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - }, - "201": { - "body": { - "sku": { - "tier": "Standard", - "capacity": 2, - "name": "Standard_A1_v2" - }, - "name": "{vmss-name}", - "properties": { - "singlePlacementGroup": false, - "overprovision": true, - "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", - "zoneBalance": false, - "virtualMachineProfile": { - "storageProfile": { - "imageReference": { - "sku": "2016-Datacenter", - "publisher": "MicrosoftWindowsServer", - "version": "latest", - "offer": "WindowsServer" - }, - "osDisk": { - "caching": "ReadWrite", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "FromImage", - "diskSizeGB": 512 - }, - "dataDisks": [ - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 0, - "diskSizeGB": 1023 - }, - { - "caching": "None", - "managedDisk": { - "storageAccountType": "Standard_LRS" - }, - "createOption": "Empty", - "lun": 1, - "diskSizeGB": 1023 - } - ] - }, - "osProfile": { - "computerNamePrefix": "{vmss-name}", - "adminUsername": "{your-username}", - "secrets": [], - "windowsConfiguration": { - "provisionVMAgent": true, - "enableAutomaticUpdates": true - } - }, - "networkProfile": { - "networkInterfaceConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "dnsSettings": { - "dnsServers": [] - }, - "primary": true, - "enableIPForwarding": true, - "ipConfigurations": [ - { - "name": "{vmss-name}", - "properties": { - "subnet": { - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" - }, - "privateIPAddressVersion": "IPv4" - } - } - ], - "enableAcceleratedNetworking": false - } - } - ] - } - }, - "upgradePolicy": { - "mode": "Automatic" - }, - "provisioningState": "Creating" - }, - "zones": [ - "1", - "3" - ], - "location": "centralus", - "type": "Microsoft.Compute/virtualMachineScaleSets", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" - } - } - } -} +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2018-04-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "location": "centralus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + } + }, + "zones": [ + "1", + "3" + ] + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Succeeded" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Creating" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json index 8da9713f82a2..ec423a5d20ce 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json @@ -441,4 +441,4 @@ "type": "string" } } -} +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json index ed3e65fefdd7..02d359b72d96 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json @@ -1,542 +1,542 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-06-27-preview", - "title": "ContainerRegistryManagementClient" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": { - "post": { - "tags": [ - "Operation" - ], - "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 60 characters in length.", - "operationId": "Registries_CheckNameAvailability", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "registryNameCheckRequest", - "in": "body", - "description": "The object containing information for the availability request.", - "required": true, - "schema": { - "$ref": "#/definitions/RegistryNameCheckRequest" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/RegistryNameStatus" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": { - "get": { - "tags": [ - "Registries" - ], - "description": "Gets the properties of the specified container registry.", - "operationId": "Registries_GetProperties", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Registry" - } - } - } - }, - "put": { - "tags": [ - "Registries" - ], - "description": "Creates or updates a container registry with the specified parameters.", - "operationId": "Registries_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - }, - { - "name": "registry", - "in": "body", - "description": "The parameters for creating or updating a container registry.", - "required": true, - "schema": { - "$ref": "#/definitions/Registry" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Registry" - } - }, - "202": { - "description": "The request was successful; the operation will complete asynchronously." - } - } - }, - "delete": { - "tags": [ - "Registries" - ], - "description": "Deletes a container registry.", - "operationId": "Registries_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly." - }, - "204": { - "description": "The container registry does not exist in the subscription." - } - } - }, - "patch": { - "tags": [ - "Registries" - ], - "description": "Updates a container registry with the specified parameters.", - "operationId": "Registries_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - }, - { - "name": "registryUpdateParameters", - "in": "body", - "description": "The parameters for updating a container registry.", - "required": true, - "schema": { - "$ref": "#/definitions/RegistryUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/Registry" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": { - "get": { - "tags": [ - "Registries" - ], - "description": "Lists all the available container registries under the specified resource group.", - "operationId": "Registries_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/RegistryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": { - "get": { - "tags": [ - "Registries" - ], - "description": "Lists all the available container registries under the specified subscription.", - "operationId": "Registries_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/RegistryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/getCredentials": { - "post": { - "tags": [ - "Registries" - ], - "description": "Gets the administrator login credentials for the specified container registry.", - "operationId": "Registries_GetCredentials", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/RegistryCredentials" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredentials": { - "post": { - "tags": [ - "Registries" - ], - "description": "Regenerates the administrator login credentials for the specified container registry.", - "operationId": "Registries_RegenerateCredentials", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/RegistryNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/RegistryCredentials" - } - } - } - } - } - }, - "definitions": { - "RegistryNameCheckRequest": { - "description": "A request to check whether the container registry name is available.", - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "description": "The name of the container registry.", - "type": "string" - }, - "type": { - "description": "The resource type of the container registry. This field must be set to \"Microsoft.ContainerRegistry/registries\".", - "enum": [ - "Microsoft.ContainerRegistry/registries" - ], - "type": "string", - "x-ms-enum": { - "name": "ContainerRegistryResourceType", - "modelAsString": false - } - } - } - }, - "RegistryNameStatus": { - "description": "The result of a request to check the availability of a container registry name.", - "properties": { - "nameAvailable": { - "description": "The value that indicates whether the name is available.", - "type": "boolean" - }, - "reason": { - "description": "If any, the reason that the name is not available.", - "type": "string" - }, - "message": { - "description": "If any, the error message that provides more detail for the reason that the name is not available.", - "type": "string" - } - } - }, - "Registry": { - "description": "An object that represents a container registry.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/RegistryProperties", - "description": "The properties of the container registry.", - "x-ms-client-flatten": true - } - } - }, - "RegistryProperties": { - "description": "The properties of a container registry.", - "required": [ - "storageAccount" - ], - "properties": { - "loginServer": { - "description": "The URL that can be used to log into the container registry.", - "type": "string", - "readOnly": true - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the container registry in ISO8601 format.", - "type": "string", - "readOnly": true - }, - "adminUserEnabled": { - "description": "The value that indicates whether the admin user is enabled. This value is false by default.", - "default": false, - "type": "boolean" - }, - "storageAccount": { - "$ref": "#/definitions/StorageAccountProperties", - "description": "The properties of the storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." - } - } - }, - "StorageAccountProperties": { - "description": "The properties of a storage account for a container registry.", - "required": [ - "name", - "accessKey" - ], - "properties": { - "name": { - "description": "The name of the storage account.", - "type": "string" - }, - "accessKey": { - "description": "The access key to the storage account.", - "type": "string" - } - } - }, - "RegistryUpdateParameters": { - "description": "The parameters for updating a container registry.", - "properties": { - "tags": { - "description": "The resource tags for the container registry.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/RegistryPropertiesUpdateParameters", - "description": "The properties that the container registry will be updated with.", - "x-ms-client-flatten": true - } - } - }, - "RegistryPropertiesUpdateParameters": { - "description": "The parameters for updating the properties of a container registry.", - "properties": { - "adminUserEnabled": { - "description": "The value that indicates whether the admin user is enabled. This value is false by default.", - "type": "boolean" - }, - "storageAccount": { - "$ref": "#/definitions/StorageAccountProperties", - "description": "The properties of a storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." - } - } - }, - "RegistryListResult": { - "description": "The result of a request to list container registries.", - "properties": { - "value": { - "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.", - "type": "array", - "items": { - "$ref": "#/definitions/Registry" - } - }, - "nextLink": { - "description": "The URI that can be used to request the next list of container registries.", - "type": "string" - } - } - }, - "RegistryCredentials": { - "description": "The result of a request to get the administrator login credentials for a container registry.", - "properties": { - "username": { - "description": "The administrator username.", - "type": "string" - }, - "password": { - "description": "The administrator password.", - "type": "string" - } - } - }, - "Resource": { - "description": "An Azure resource.", - "required": [ - "location" - ], - "properties": { - "id": { - "description": "The resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "The location of the resource. This cannot be changed after the resource is created.", - "type": "string" - }, - "tags": { - "description": "The tags of the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "x-ms-azure-resource": true - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Microsoft Azure subscription ID.", - "required": true, - "type": "string" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The client API version.", - "required": true, - "type": "string" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group to which the container registry belongs.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "RegistryNameParameter": { - "name": "registryName", - "in": "path", - "description": "The name of the container registry.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } +{ + "swagger": "2.0", + "info": { + "version": "2016-06-27-preview", + "title": "ContainerRegistryManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability": { + "post": { + "tags": [ + "Operation" + ], + "description": "Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 60 characters in length.", + "operationId": "Registries_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "registryNameCheckRequest", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryNameCheckRequest" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryNameStatus" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}": { + "get": { + "tags": [ + "Registries" + ], + "description": "Gets the properties of the specified container registry.", + "operationId": "Registries_GetProperties", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + } + } + }, + "put": { + "tags": [ + "Registries" + ], + "description": "Creates or updates a container registry with the specified parameters.", + "operationId": "Registries_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "registry", + "in": "body", + "description": "The parameters for creating or updating a container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/Registry" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + } + } + }, + "delete": { + "tags": [ + "Registries" + ], + "description": "Deletes a container registry.", + "operationId": "Registries_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The container registry does not exist in the subscription." + } + } + }, + "patch": { + "tags": [ + "Registries" + ], + "description": "Updates a container registry with the specified parameters.", + "operationId": "Registries_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + }, + { + "name": "registryUpdateParameters", + "in": "body", + "description": "The parameters for updating a container registry.", + "required": true, + "schema": { + "$ref": "#/definitions/RegistryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Registry" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists all the available container registries under the specified resource group.", + "operationId": "Registries_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries": { + "get": { + "tags": [ + "Registries" + ], + "description": "Lists all the available container registries under the specified subscription.", + "operationId": "Registries_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/getCredentials": { + "post": { + "tags": [ + "Registries" + ], + "description": "Gets the administrator login credentials for the specified container registry.", + "operationId": "Registries_GetCredentials", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryCredentials" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredentials": { + "post": { + "tags": [ + "Registries" + ], + "description": "Regenerates the administrator login credentials for the specified container registry.", + "operationId": "Registries_RegenerateCredentials", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/RegistryNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/RegistryCredentials" + } + } + } + } + } + }, + "definitions": { + "RegistryNameCheckRequest": { + "description": "A request to check whether the container registry name is available.", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The name of the container registry.", + "type": "string" + }, + "type": { + "description": "The resource type of the container registry. This field must be set to \"Microsoft.ContainerRegistry/registries\".", + "enum": [ + "Microsoft.ContainerRegistry/registries" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerRegistryResourceType", + "modelAsString": false + } + } + } + }, + "RegistryNameStatus": { + "description": "The result of a request to check the availability of a container registry name.", + "properties": { + "nameAvailable": { + "description": "The value that indicates whether the name is available.", + "type": "boolean" + }, + "reason": { + "description": "If any, the reason that the name is not available.", + "type": "string" + }, + "message": { + "description": "If any, the error message that provides more detail for the reason that the name is not available.", + "type": "string" + } + } + }, + "Registry": { + "description": "An object that represents a container registry.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RegistryProperties", + "description": "The properties of the container registry.", + "x-ms-client-flatten": true + } + } + }, + "RegistryProperties": { + "description": "The properties of a container registry.", + "required": [ + "storageAccount" + ], + "properties": { + "loginServer": { + "description": "The URL that can be used to log into the container registry.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the container registry in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "adminUserEnabled": { + "description": "The value that indicates whether the admin user is enabled. This value is false by default.", + "default": false, + "type": "boolean" + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "The properties of the storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." + } + } + }, + "StorageAccountProperties": { + "description": "The properties of a storage account for a container registry.", + "required": [ + "name", + "accessKey" + ], + "properties": { + "name": { + "description": "The name of the storage account.", + "type": "string" + }, + "accessKey": { + "description": "The access key to the storage account.", + "type": "string" + } + } + }, + "RegistryUpdateParameters": { + "description": "The parameters for updating a container registry.", + "properties": { + "tags": { + "description": "The resource tags for the container registry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/RegistryPropertiesUpdateParameters", + "description": "The properties that the container registry will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "RegistryPropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a container registry.", + "properties": { + "adminUserEnabled": { + "description": "The value that indicates whether the admin user is enabled. This value is false by default.", + "type": "boolean" + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "The properties of a storage account for the container registry. If specified, the storage account must be in the same physical location as the container registry." + } + } + }, + "RegistryListResult": { + "description": "The result of a request to list container registries.", + "properties": { + "value": { + "description": "The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries.", + "type": "array", + "items": { + "$ref": "#/definitions/Registry" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of container registries.", + "type": "string" + } + } + }, + "RegistryCredentials": { + "description": "The result of a request to get the administrator login credentials for a container registry.", + "properties": { + "username": { + "description": "The administrator username.", + "type": "string" + }, + "password": { + "description": "The administrator password.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RegistryNameParameter": { + "name": "registryName", + "in": "path", + "description": "The name of the container registry.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json index 13c5e57b598a..797d1eee2289 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json @@ -1,3901 +1,3901 @@ -{ - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2017-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": { - "/providers/Microsoft.DataFactory/operations": { - "get": { - "tags": [ - "operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "description": "Lists the available Azure Data Factory API operations.", - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/OperationListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories": { - "get": { - "tags": [ - "factories" - ], - "operationId": "Factories_List", - "x-ms-examples": { - "Factories_List": { - "$ref": "./examples/Factories_List.json" - } - }, - "description": "Lists factories under the specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/FactoryListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { - "post": { - "tags": [ - "configureFactoryRepo" - ], - "operationId": "Factories_ConfigureFactoryRepo", - "x-ms-examples": { - "Factories_ConfigureFactoryRepo": { - "$ref": "./examples/Factories_ConfigureFactoryRepo.json" - } - }, - "description": "Updates a factory's repo information.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/locationId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "factoryRepoUpdate", - "description": "Update factory repo request definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FactoryRepoUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/Factory" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { - "get": { - "tags": [ - "factories" - ], - "operationId": "Factories_ListByResourceGroup", - "x-ms-examples": { - "Factories_ListByResourceGroup": { - "$ref": "./examples/Factories_ListByResourceGroup.json" - } - }, - "description": "Lists factories.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/FactoryListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}": { - "put": { - "tags": [ - "factories" - ], - "operationId": "Factories_CreateOrUpdate", - "x-ms-examples": { - "Factories_CreateOrUpdate": { - "$ref": "./examples/Factories_CreateOrUpdate.json" - } - }, - "description": "Creates or updates a factory.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "factory", - "description": "Factory resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Factory" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/Factory" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "factories" - ], - "operationId": "Factories_Update", - "x-ms-examples": { - "Factories_Update": { - "$ref": "./examples/Factories_Update.json" - } - }, - "description": "Updates a factory.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "factoryUpdateParameters", - "description": "The parameters for updating a factory.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/FactoryUpdateParameters" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/Factory" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "factories" - ], - "operationId": "Factories_Get", - "x-ms-examples": { - "Factories_Get": { - "$ref": "./examples/Factories_Get.json" - } - }, - "description": "Gets a factory.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/Factory" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "factories" - ], - "operationId": "Factories_Delete", - "x-ms-examples": { - "Factories_Delete": { - "$ref": "./examples/Factories_Delete.json" - } - }, - "description": "Deletes a factory.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { - "get": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_ListByFactory", - "x-ms-examples": { - "IntegrationRuntimes_ListByFactory": { - "$ref": "./examples/IntegrationRuntimes_ListByFactory.json" - } - }, - "description": "Lists integration runtimes.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}": { - "put": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_CreateOrUpdate", - "x-ms-examples": { - "IntegrationRuntimes_Create": { - "$ref": "./examples/IntegrationRuntimes_Create.json" - } - }, - "description": "Creates or updates an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "description": "ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." - }, - { - "name": "integrationRuntime", - "description": "Integration runtime resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IntegrationRuntimeResource" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeResource" - } - }, - "default": { - "description": "An error response received from PUT integration runtime operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Get", - "x-ms-examples": { - "IntegrationRuntimes_Get": { - "$ref": "./examples/IntegrationRuntimes_Get.json" - } - }, - "description": "Gets an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeResource" - } - }, - "default": { - "description": "An error response received from GET integration runtime operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Update", - "x-ms-examples": { - "IntegrationRuntimes_Update": { - "$ref": "./examples/IntegrationRuntimes_Update.json" - } - }, - "description": "Updates an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "updateIntegrationRuntimeRequest", - "description": "The parameters for updating an integration runtime.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeStatusResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Delete", - "x-ms-examples": { - "IntegrationRuntimes_Delete": { - "$ref": "./examples/IntegrationRuntimes_Delete.json" - } - }, - "description": "Deletes an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from DELETE integration runtime operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_GetStatus", - "x-ms-examples": { - "IntegrationRuntimes_GetStatus": { - "$ref": "./examples/IntegrationRuntimes_GetStatus.json" - } - }, - "description": "Gets detailed status information for an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeStatusResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_GetConnectionInfo", - "x-ms-examples": { - "IntegrationRuntimes_GetConnectionInfo": { - "$ref": "./examples/IntegrationRuntimes_GetConnectionInfo.json" - } - }, - "description": "Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeConnectionInfo" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_RegenerateAuthKey", - "x-ms-examples": { - "IntegrationRuntimes_RegenerateAuthKey": { - "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" - } - }, - "description": "Regenerates the authentication key for an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "regenerateKeyParameters", - "description": "The parameters for regenerating integration runtime authentication key.", - "in": "body", - "required": true, - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeRegenerateKeyParameters" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_ListAuthKeys", - "x-ms-examples": { - "IntegrationRuntimes_ListAuthKeys": { - "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" - } - }, - "description": "Retrieves the authentication keys for an integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Start", - "x-ms-examples": { - "IntegrationRuntimes_Start": { - "$ref": "./examples/IntegrationRuntimes_Start.json" - } - }, - "description": "Starts a ManagedReserved type integration runtime.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/IntegrationRuntimeStatusResponse" - } - }, - "202": { - "description": "Accepted." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Stop", - "x-ms-examples": { - "IntegrationRuntimes_Stop": { - "$ref": "./examples/IntegrationRuntimes_Stop.json" - } - }, - "description": "Stops a ManagedReserved type integration runtime.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeNode": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_RemoveNode", - "x-ms-examples": { - "IntegrationRuntimes_RemoveNode": { - "$ref": "./examples/IntegrationRuntimes_RemoveNode.json" - } - }, - "description": "Remove a node from integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "removeNodeParameters", - "description": "The name of the node to be removed from an integration runtime.", - "in": "body", - "required": true, - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeRemoveNodeRequest" - } - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_SyncCredentials", - "x-ms-examples": { - "IntegrationRuntimes_SyncCredentials": { - "$ref": "./examples/IntegrationRuntimes_SyncCredentials.json" - } - }, - "description": "Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_GetMonitoringData", - "x-ms-examples": { - "IntegrationRuntimes_GetMonitoringData": { - "$ref": "./examples/IntegrationRuntimes_GetMonitoringData.json" - } - }, - "description": "Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeMonitoringData" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { - "post": { - "tags": [ - "integrationRuntimes" - ], - "operationId": "IntegrationRuntimes_Upgrade", - "x-ms-examples": { - "IntegrationRuntimes_Upgrade": { - "$ref": "./examples/IntegrationRuntimes_Upgrade.json" - } - }, - "description": "Upgrade self-hosted integration runtime to latest version if availably.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { - "delete": { - "tags": [ - "integrationRuntimeNodes" - ], - "operationId": "IntegrationRuntimeNodes_Delete", - "x-ms-examples": { - "IntegrationRuntimesNodes_Delete": { - "$ref": "./examples/IntegrationRuntimeNodes_Delete.json" - } - }, - "description": "Deletes a self-hosted integration runtime node.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/nodeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "integrationRuntimeNodes" - ], - "operationId": "IntegrationRuntimeNodes_Update", - "x-ms-examples": { - "IntegrationRuntimeNodes_Update": { - "$ref": "./examples/IntegrationRuntimeNodes_Update.json" - } - }, - "description": "Updates a self-hosted integration runtime node.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/nodeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "updateIntegrationRuntimeNodeRequest", - "description": "The parameters for updating an integration runtime node.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/SelfHostedIntegrationRuntimeNode" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { - "post": { - "tags": [ - "integrationRuntimeNodes" - ], - "operationId": "IntegrationRuntimeNodes_GetIpAddress", - "x-ms-examples": { - "IntegrationRuntimeNodes_GetIpAddress": { - "$ref": "./examples/IntegrationRuntimeNodes_GetIpAddress.json" - } - }, - "description": "Get the IP address of self-hosted integration runtime node.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/integrationRuntimeName" - }, - { - "$ref": "#/parameters/nodeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeNodeIpAddress" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices": { - "get": { - "tags": [ - "linkedServices" - ], - "operationId": "LinkedServices_ListByFactory", - "x-ms-examples": { - "LinkedServices_ListByFactory": { - "$ref": "./examples/LinkedServices_ListByFactory.json" - } - }, - "description": "Lists linked services.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/LinkedServiceListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}": { - "put": { - "tags": [ - "linkedServices" - ], - "operationId": "LinkedServices_CreateOrUpdate", - "x-ms-examples": { - "LinkedServices_Create": { - "$ref": "./examples/LinkedServices_Create.json" - }, - "LinkedServices_Update": { - "$ref": "./examples/LinkedServices_Update.json" - } - }, - "description": "Creates or updates a linked service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/linkedServiceName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." - }, - { - "name": "linkedService", - "description": "Linked service resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/LinkedServiceResource" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/LinkedServiceResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "linkedServices" - ], - "operationId": "LinkedServices_Get", - "x-ms-examples": { - "LinkedServices_Get": { - "$ref": "./examples/LinkedServices_Get.json" - } - }, - "description": "Gets a linked service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/linkedServiceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/LinkedServiceResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "linkedServices" - ], - "operationId": "LinkedServices_Delete", - "x-ms-examples": { - "LinkedServices_Delete": { - "$ref": "./examples/LinkedServices_Delete.json" - } - }, - "description": "Deletes a linked service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/linkedServiceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets": { - "get": { - "tags": [ - "datasets" - ], - "operationId": "Datasets_ListByFactory", - "x-ms-examples": { - "Datasets_ListByFactory": { - "$ref": "./examples/Datasets_ListByFactory.json" - } - }, - "description": "Lists datasets.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/DatasetListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}": { - "put": { - "tags": [ - "datasets" - ], - "operationId": "Datasets_CreateOrUpdate", - "x-ms-examples": { - "Datasets_Create": { - "$ref": "./examples/Datasets_Create.json" - }, - "Datasets_Update": { - "$ref": "./examples/Datasets_Update.json" - } - }, - "description": "Creates or updates a dataset.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/datasetName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." - }, - { - "name": "dataset", - "description": "Dataset resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DatasetResource" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/DatasetResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "datasets" - ], - "operationId": "Datasets_Get", - "x-ms-examples": { - "Datasets_Get": { - "$ref": "./examples/Datasets_Get.json" - } - }, - "description": "Gets a dataset.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/datasetName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/DatasetResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "datasets" - ], - "operationId": "Datasets_Delete", - "x-ms-examples": { - "Datasets_Delete": { - "$ref": "./examples/Datasets_Delete.json" - } - }, - "description": "Deletes a dataset.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/datasetName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines": { - "get": { - "tags": [ - "pipelines" - ], - "operationId": "Pipelines_ListByFactory", - "x-ms-examples": { - "Pipelines_ListByFactory": { - "$ref": "./examples/Pipelines_ListByFactory.json" - } - }, - "description": "Lists pipelines.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/PipelineListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}": { - "put": { - "tags": [ - "pipelines" - ], - "operationId": "Pipelines_CreateOrUpdate", - "x-ms-examples": { - "Pipelines_Create": { - "$ref": "./examples/Pipelines_Create.json" - }, - "Pipelines_Update": { - "$ref": "./examples/Pipelines_Update.json" - } - }, - "description": "Creates or updates a pipeline.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/pipelineName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." - }, - { - "name": "pipeline", - "description": "Pipeline resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PipelineResource" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/PipelineResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "pipelines" - ], - "operationId": "Pipelines_Get", - "x-ms-examples": { - "Pipelines_Get": { - "$ref": "./examples/Pipelines_Get.json" - } - }, - "description": "Gets a pipeline.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/pipelineName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/PipelineResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "pipelines" - ], - "operationId": "Pipelines_Delete", - "x-ms-examples": { - "Pipelines_Delete": { - "$ref": "./examples/Pipelines_Delete.json" - } - }, - "description": "Deletes a pipeline.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/pipelineName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun": { - "post": { - "tags": [ - "pipelines" - ], - "operationId": "Pipelines_CreateRun", - "x-ms-examples": { - "Pipelines_CreateRun": { - "$ref": "./examples/Pipelines_CreateRun.json" - } - }, - "description": "Creates a run of a pipeline.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/pipelineName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "description": "Parameters of the pipeline run.", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ParameterValueSpecification" - } - } - ], - "responses": { - "202": { - "description": "Accepted.", - "schema": { - "$ref": "#/definitions/CreateRunResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns": { - "post": { - "operationId": "PipelineRuns_QueryByFactory", - "x-ms-examples": { - "PipelineRuns_QueryByFactory": { - "$ref": "./examples/PipelineRuns_QueryByFactory.json" - } - }, - "description": "Query pipeline runs in the factory based on input filter conditions.", - "tags": [ - "pipelineruns" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "filterParameters", - "description": "Parameters to filter the pipeline run.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PipelineRunFilterParameters" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/PipelineRunQueryResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}": { - "get": { - "operationId": "PipelineRuns_Get", - "x-ms-examples": { - "PipelineRuns_Get": { - "$ref": "./examples/PipelineRuns_Get.json" - } - }, - "description": "Get a pipeline run by its run ID.", - "tags": [ - "pipelineruns" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/runId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/PipelineRun" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns": { - "get": { - "operationId": "ActivityRuns_ListByPipelineRun", - "x-ms-examples": { - "ActivityRuns_ListByPipelineRun": { - "$ref": "./examples/ActivityRuns_ListByPipelineRun.json" - } - }, - "description": "List activity runs based on input filter conditions.", - "tags": [ - "activityruns" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/runId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "startTime", - "description": "The start time of activity runs in ISO8601 format.", - "in": "query", - "required": true, - "type": "string", - "format": "date-time" - }, - { - "name": "endTime", - "description": "The end time of activity runs in ISO8601 format.", - "in": "query", - "required": true, - "type": "string", - "format": "date-time" - }, - { - "name": "status", - "description": "The status of the pipeline run.", - "type": "string", - "in": "query", - "required": false - }, - { - "name": "activityName", - "description": "The name of the activity.", - "type": "string", - "in": "query", - "required": false - }, - { - "name": "linkedServiceName", - "description": "The linked service name.", - "in": "query", - "required": false, - "type": "string", - "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", - "minLength": 1, - "maxLength": 260 - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/ActivityRunsListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}": { - "post": { - "operationId": "Factories_CancelPipelineRun", - "x-ms-examples": { - "Factories_CancelPipelineRun": { - "$ref": "./examples/Factories_CancelPipelineRun.json" - } - }, - "description": "Cancel a pipeline run by its run ID.", - "tags": [ - "pipelineruns" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/runId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Pipeline run has been canceled successfully. " - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": { - "get": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_ListByFactory", - "x-ms-examples": { - "Triggers_ListByFactory": { - "$ref": "./examples/Triggers_ListByFactory.json" - } - }, - "description": "Lists triggers.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/TriggerListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}": { - "put": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_CreateOrUpdate", - "x-ms-examples": { - "Triggers_Create": { - "$ref": "./examples/Triggers_Create.json" - }, - "Triggers_Update": { - "$ref": "./examples/Triggers_Update.json" - } - }, - "description": "Creates or updates a trigger.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "type": "string", - "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." - }, - { - "name": "trigger", - "description": "Trigger resource definition.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TriggerResource" - } - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/TriggerResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "trigger" - ], - "operationId": "Triggers_Get", - "x-ms-examples": { - "Triggers_Get": { - "$ref": "./examples/Triggers_Get.json" - } - }, - "description": "Gets a trigger.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/TriggerResource" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_Delete", - "x-ms-examples": { - "Triggers_Delete": { - "$ref": "./examples/Triggers_Delete.json" - } - }, - "description": "Deletes a trigger.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "204": { - "description": "No Content." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start": { - "post": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_Start", - "x-ms-examples": { - "Triggers_Start": { - "$ref": "./examples/Triggers_Start.json" - } - }, - "description": "Starts a trigger.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Trigger has been started successfully." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop": { - "post": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_Stop", - "x-ms-examples": { - "Triggers_Stop": { - "$ref": "./examples/Triggers_Stop.json" - } - }, - "description": "Stops a trigger.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Trigger has been stopped successfully." - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerruns": { - "get": { - "tags": [ - "triggers" - ], - "operationId": "Triggers_ListRuns", - "x-ms-examples": { - "Triggers_ListRuns": { - "$ref": "./examples/Triggers_ListRuns.json" - } - }, - "description": "List trigger runs.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/factoryName" - }, - { - "$ref": "#/parameters/triggerName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "startTime", - "description": "Start time for trigger runs.", - "type": "string", - "format": "date-time", - "in": "query", - "required": true - }, - { - "name": "endTime", - "description": "End time for trigger runs.", - "type": "string", - "format": "date-time", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/TriggerRunListResponse" - } - }, - "default": { - "description": "An error response received from the Azure Data Factory service.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Resource": { - "x-ms-azure-resource": true, - "description": "Azure Data Factory top-level resource.", - "properties": { - "id": { - "type": "string", - "description": "The resource identifier.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The resource type.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "The resource location.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - } - } - }, - "SubResource": { - "description": "Azure Data Factory nested resource, which belongs to a factory.", - "properties": { - "id": { - "type": "string", - "description": "The resource identifier.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "The resource type.", - "readOnly": true - }, - "etag": { - "type": "string", - "description": "Etag identifies change in the resource.", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "Expression": { - "description": "Azure Data Factory expression definition.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Expression type.", - "enum": [ - "Expression" - ] - }, - "value": { - "type": "string", - "description": "Expression value." - } - }, - "required": [ - "type", - "value" - ] - }, - "SecureString": { - "x-ms-discriminator-value": "SecureString", - "description": "Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SecretBase" - } - ], - "properties": { - "value": { - "type": "string", - "description": "Value of secure string." - } - }, - "required": [ - "value" - ] - }, - "AzureKeyVaultSecretReference": { - "x-ms-discriminator-value": "AzureKeyVaultSecret", - "description": "Azure Key Vault secret reference.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SecretBase" - } - ], - "properties": { - "store": { - "description": "The Azure Key Vault linked service reference.", - "$ref": "#/definitions/LinkedServiceReference" - }, - "secretName": { - "type": "object", - "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." - }, - "secretVersion": { - "type": "object", - "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "store", - "secretName" - ] - }, - "SecretBase": { - "description": "The base definition of a secret type.", - "discriminator": "type", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the secret." - } - }, - "required": [ - "type" - ] - }, - "FactoryListResponse": { - "description": "A list of factory resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of factories.", - "items": { - "$ref": "#/definitions/Factory" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "IntegrationRuntimeListResponse": { - "description": "A list of integration runtime resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of integration runtimes.", - "items": { - "$ref": "#/definitions/IntegrationRuntimeResource" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "IntegrationRuntimeReference": { - "description": "Integration runtime reference type.", - "properties": { - "type": { - "type": "string", - "description": "Type of integration runtime.", - "enum": [ - "IntegrationRuntimeReference" - ] - }, - "referenceName": { - "type": "string", - "description": "Reference integration runtime name." - }, - "parameters": { - "$ref": "#/definitions/ParameterValueSpecification", - "description": "Arguments for integration runtime." - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "IntegrationRuntimeResource": { - "description": "Integration runtime resource type.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntime", - "description": "Integration runtime properties." - } - }, - "required": [ - "properties" - ] - }, - "IntegrationRuntimeStatusResponse": { - "description": "Integration runtime status response.", - "properties": { - "name": { - "type": "string", - "description": "The integration runtime name.", - "readOnly": true - }, - "properties": { - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeStatus", - "description": "Integration runtime properties." - } - }, - "required": [ - "properties" - ] - }, - "IntegrationRuntimeStatusListResponse": { - "description": "A list of integration runtime status.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of integration runtime status.", - "items": { - "$ref": "#/definitions/IntegrationRuntimeStatusResponse" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "UpdateIntegrationRuntimeRequest": { - "description": "Update integration runtime request.", - "type": "object", - "properties": { - "autoUpdate": { - "description": "Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.", - "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAutoUpdate" - }, - "updateDelayOffset": { - "description": "The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.", - "type": "string" - } - } - }, - "UpdateIntegrationRuntimeNodeRequest": { - "description": "Update integration runtime node request.", - "type": "object", - "properties": { - "concurrentJobsLimit": { - "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", - "type": "integer", - "minimum": 1 - } - } - }, - "LinkedServiceListResponse": { - "description": "A list of linked service resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of linked services.", - "items": { - "$ref": "#/definitions/LinkedServiceResource" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "DatasetListResponse": { - "description": "A list of dataset resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of datasets.", - "items": { - "$ref": "#/definitions/DatasetResource" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "PipelineListResponse": { - "description": "A list of pipeline resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of pipelines.", - "items": { - "$ref": "#/definitions/PipelineResource" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "TriggerListResponse": { - "description": "A list of trigger resources.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of triggers.", - "items": { - "$ref": "#/definitions/TriggerResource" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "CreateRunResponse": { - "description": "Response body with a run identifier.", - "type": "object", - "properties": { - "runId": { - "description": "Identifier of a run.", - "type": "string" - } - }, - "required": [ - "runId" - ] - }, - "ErrorResponse": { - "description": "The object that defines the structure of an Azure Data Factory response.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - }, - "target": { - "description": "Property name/path in request associated with error.", - "type": "string" - }, - "details": { - "description": "Array with additional error details.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "required": [ - "code", - "message" - ] - }, - "ParameterDefinitionSpecification": { - "description": "Definition of all parameters for an entity.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ParameterSpecification" - } - }, - "ParameterSpecification": { - "description": "Definition of a single parameter for an entity.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Parameter type.", - "enum": [ - "Object", - "String", - "Int", - "Float", - "Bool", - "Array", - "SecureString" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": true - } - }, - "defaultValue": { - "type": "object", - "description": "Default value of parameter." - } - }, - "required": [ - "type" - ] - }, - "ParameterValueSpecification": { - "description": "An object mapping parameter names to argument values.", - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "FactoryVSTSConfiguration": { - "description": "Factory's VSTS repo information.", - "properties": { - "accountName": { - "description": "VSTS account name.", - "type": "string" - }, - "projectName": { - "description": "VSTS project name.", - "type": "string" - }, - "repositoryName": { - "description": "VSTS repository name.", - "type": "string" - }, - "collaborationBranch": { - "description": "VSTS collaboration branch.", - "type": "string" - }, - "rootFolder": { - "description": "VSTS root folder.", - "type": "string" - }, - "lastCommitId": { - "description": "VSTS last commit id.", - "type": "string" - }, - "tenantId": { - "description": "VSTS tenant id.", - "type": "string" - } - } - }, - "FactoryRepoUpdate": { - "description": "Factory's VSTS repo information.", - "properties": { - "factoryResourceId": { - "description": "The factory resource id.", - "type": "string" - }, - "resourceGroupName": { - "description": "The resource group name.", - "type": "string" - }, - "vstsConfiguration": { - "$ref": "#/definitions/FactoryVSTSConfiguration", - "description": "VSTS repo information of the factory." - } - } - }, - "FactoryProperties": { - "description": "Factory resource properties.", - "properties": { - "provisioningState": { - "description": "Factory provisioning state, example Succeeded.", - "type": "string", - "readOnly": true - }, - "createTime": { - "description": "Time the factory was created in ISO8601 format.", - "type": "string", - "readOnly": true, - "format": "date-time" - }, - "version": { - "description": "Version of the factory.", - "type": "string", - "readOnly": true - }, - "vstsConfiguration": { - "$ref": "#/definitions/FactoryVSTSConfiguration", - "description": "VSTS repo information of the factory." - } - } - }, - "PipelineResource": { - "description": "Pipeline resource type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "./entityTypes/Pipeline.json#/definitions/Pipeline", - "description": "Properties of the pipeline." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "properties" - ] - }, - "PipelineReference": { - "description": "Pipeline reference type.", - "properties": { - "type": { - "type": "string", - "description": "Pipeline reference type.", - "enum": [ - "PipelineReference" - ] - }, - "referenceName": { - "type": "string", - "description": "Reference pipeline name." - }, - "name": { - "type": "string", - "description": "Reference name." - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "TriggerPipelineReference": { - "description": "Pipeline that needs to be triggered with the given parameters.", - "properties": { - "pipelineReference": { - "description": "Pipeline reference.", - "$ref": "#/definitions/PipelineReference" - }, - "parameters": { - "description": "Pipeline parameters.", - "$ref": "#/definitions/ParameterValueSpecification" - } - } - }, - "TriggerResource": { - "description": "Trigger resource type.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/Trigger.json#/definitions/Trigger", - "description": "Properties of the trigger." - } - }, - "required": [ - "properties" - ] - }, - "Factory": { - "description": "Factory resource type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "identity": { - "$ref": "#/definitions/FactoryIdentity", - "description": "Managed service identity of the factory." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FactoryProperties", - "description": "Properties of the factory." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "FactoryUpdateParameters": { - "description": "Parameters for updating a factory resource.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - }, - "identity": { - "$ref": "#/definitions/FactoryIdentity", - "description": "Managed service identity of the factory." - } - } - }, - "FactoryIdentity": { - "description": "Identity properties of the factory resource.", - "properties": { - "type": { - "type": "string", - "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", - "enum": [ - "SystemAssigned" - ], - "x-ms-enum": { - "name": "FactoryIdentityType", - "modelAsString": false - } - }, - "principalId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "The principal id of the identity." - }, - "tenantId": { - "type": "string", - "format": "uuid", - "readOnly": true, - "description": "The client tenant id of the identity." - } - }, - "required": [ - "type" - ] - }, - "DatasetReference": { - "description": "Dataset reference type.", - "properties": { - "type": { - "type": "string", - "description": "Dataset reference type.", - "enum": [ - "DatasetReference" - ] - }, - "referenceName": { - "type": "string", - "description": "Reference dataset name." - }, - "parameters": { - "$ref": "#/definitions/ParameterValueSpecification", - "description": "Arguments for dataset." - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "DatasetResource": { - "description": "Dataset resource type.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", - "description": "Dataset properties." - } - }, - "required": [ - "properties" - ] - }, - "LinkedServiceReference": { - "description": "Linked service reference type.", - "properties": { - "type": { - "type": "string", - "description": "Linked service reference type.", - "enum": [ - "LinkedServiceReference" - ] - }, - "referenceName": { - "type": "string", - "description": "Reference LinkedService name." - }, - "parameters": { - "$ref": "#/definitions/ParameterValueSpecification", - "description": "Arguments for LinkedService." - } - }, - "required": [ - "type", - "referenceName" - ] - }, - "LinkedServiceResource": { - "description": "Linked service resource type.", - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "properties": { - "properties": { - "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", - "description": "Properties of linked service." - } - }, - "required": [ - "properties" - ] - }, - "PipelineRunFilterParameters": { - "description": "Query parameters for listing pipeline runs.", - "type": "object", - "properties": { - "continuationToken": { - "description": "The continuation token for getting the next page of results. Null for first page.", - "type": "string" - }, - "lastUpdatedAfter": { - "description": "The time at or after which the pipeline run event was updated in 'ISO 8601' format.", - "type": "string", - "format": "date-time" - }, - "lastUpdatedBefore": { - "description": "The time at or before which the pipeline run event was updated in 'ISO 8601' format.", - "type": "string", - "format": "date-time" - }, - "filters": { - "type": "array", - "description": "List of filters.", - "items": { - "$ref": "#/definitions/PipelineRunQueryFilter" - } - }, - "orderBy": { - "type": "array", - "description": "List of OrderBy option.", - "items": { - "$ref": "#/definitions/PipelineRunQueryOrderBy" - } - } - }, - "required": [ - "lastUpdatedAfter", - "lastUpdatedBefore" - ] - }, - "PipelineRunQueryFilter": { - "description": "Query filter option for listing pipeline runs.", - "type": "object", - "properties": { - "operand": { - "description": "Parameter name to be used for filter.", - "type": "string", - "enum": [ - "PipelineName", - "Status", - "RunStart", - "RunEnd" - ], - "x-ms-enum": { - "name": "PipelineRunQueryFilterOperand", - "modelAsString": true - } - }, - "operator": { - "description": "Operator to be used for filter.", - "type": "string", - "enum": [ - "Equals", - "NotEquals", - "In", - "NotIn" - ], - "x-ms-enum": { - "name": "PipelineRunQueryFilterOperator", - "modelAsString": true - } - }, - "values": { - "type": "array", - "description": "List of filter values.", - "items": { - "type": "string" - } - } - }, - "required": [ - "operand", - "operator", - "values" - ] - }, - "PipelineRunQueryOrderBy": { - "description": "An object to provide order by options for listing pipeline runs.", - "type": "object", - "properties": { - "orderBy": { - "description": "Parameter name to be used for order by.", - "type": "string", - "enum": [ - "RunStart", - "RunEnd" - ], - "x-ms-enum": { - "name": "PipelineRunQueryOrderByField", - "modelAsString": true - } - }, - "order": { - "description": "Sorting order of the parameter.", - "type": "string", - "enum": [ - "ASC", - "DESC" - ], - "x-ms-enum": { - "name": "PipelineRunQueryOrder", - "modelAsString": true - } - } - }, - "required": [ - "orderBy", - "order" - ] - }, - "PipelineRunQueryResponse": { - "description": "A list pipeline runs.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of pipeline runs.", - "items": { - "$ref": "#/definitions/PipelineRun" - } - }, - "continuationToken": { - "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", - "type": "string" - } - } - }, - "PipelineRun": { - "description": "Information about a pipeline run.", - "type": "object", - "properties": { - "runId": { - "description": "Identifier of a run.", - "type": "string", - "readOnly": true - }, - "pipelineName": { - "description": "The pipeline name.", - "type": "string", - "readOnly": true - }, - "parameters": { - "description": "The full or partial list of parameter name, value pair used in the pipeline run.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - }, - "invokedBy": { - "description": "Entity that started the pipeline run.", - "$ref": "#/definitions/PipelineRunInvokedBy", - "readOnly": true - }, - "lastUpdated": { - "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "runStart": { - "description": "The start time of a pipeline run in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "runEnd": { - "description": "The end time of a pipeline run in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "durationInMs": { - "description": "The duration of a pipeline run.", - "type": "integer", - "readOnly": true - }, - "status": { - "description": "The status of a pipeline run.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The message from a pipeline run.", - "type": "string", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "PipelineRunInvokedBy": { - "description": "Provides entity name and id that started the pipeline run.", - "type": "object", - "properties": { - "name": { - "description": "Name of the entity that started the pipeline run.", - "type": "string", - "readOnly": true - }, - "id": { - "description": "The ID of the entity that started the run.", - "type": "string", - "readOnly": true - } - } - }, - "ActivityRunsListResponse": { - "description": "A list activity runs.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of activity runs.", - "items": { - "$ref": "#/definitions/ActivityRun" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "ActivityRun": { - "description": "Information about an activity run in a pipeline.", - "type": "object", - "properties": { - "pipelineName": { - "description": "The name of the pipeline.", - "type": "string", - "readOnly": true - }, - "pipelineRunId": { - "description": "The id of the pipeline run.", - "type": "string", - "readOnly": true - }, - "activityName": { - "description": "The name of the activity.", - "type": "string", - "readOnly": true - }, - "activityType": { - "description": "The type of the activity.", - "type": "string", - "readOnly": true - }, - "activityRunId": { - "description": "The id of the activity run.", - "type": "string", - "readOnly": true - }, - "linkedServiceName": { - "description": "The name of the compute linked service.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The status of the activity run.", - "type": "string", - "readOnly": true - }, - "activityRunStart": { - "description": "The start time of the activity run in 'ISO 8601' format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "activityRunEnd": { - "description": "The end time of the activity run in 'ISO 8601' format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "durationInMs": { - "description": "The duration of the activity run.", - "type": "integer", - "readOnly": true - }, - "input": { - "description": "The input for the activity.", - "type": "object", - "readOnly": true - }, - "output": { - "description": "The output for the activity.", - "type": "object", - "readOnly": true - }, - "error": { - "description": "The error if any from the activity run.", - "type": "object", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "TriggerRunListResponse": { - "description": "A list of trigger runs.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of trigger runs.", - "items": { - "$ref": "#/definitions/TriggerRun" - } - }, - "nextLink": { - "description": "The link to the next page of results, if any remaining results exist.", - "type": "string" - } - } - }, - "TriggerRun": { - "description": "Trigger runs.", - "type": "object", - "properties": { - "triggerRunId": { - "type": "string", - "description": "Trigger run id.", - "readOnly": true - }, - "triggerName": { - "type": "string", - "description": "Trigger name.", - "readOnly": true - }, - "triggerType": { - "type": "string", - "description": "Trigger type.", - "readOnly": true - }, - "triggerRunTimestamp": { - "type": "string", - "format": "date-time", - "description": "Trigger run start time.", - "readOnly": true - }, - "status": { - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Inprogress" - ], - "x-ms-enum": { - "name": "TriggerRunStatus", - "modelAsString": true - }, - "description": "Trigger run status.", - "readOnly": true - }, - "message": { - "type": "string", - "description": "Trigger error message.", - "readOnly": true - }, - "properties": { - "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - }, - "triggeredPipelines": { - "description": "List of pipeline name and run Id triggered by the trigger run.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "OperationListResponse": { - "description": "A list of operations that can be performed by the Data Factory service.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Data Factory operations supported by the Data Factory resource provider." - }, - "nextLink": { - "type": "string", - "description": "The link to the next page of results, if any remaining results exist." - } - } - }, - "Operation": { - "description": "Azure Data Factory API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "origin": { - "description": "The intended executor of the operation.", - "type": "string" - }, - "display": { - "description": "Metadata associated with the operation.", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "provider": { - "description": "The name of the provider.", - "type": "string" - }, - "resource": { - "description": "The name of the resource type on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "The type of operation: get, read, delete, etc.", - "type": "string" - } - } - }, - "properties": { - "description": "Additional details about the operation.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationProperties" - } - } - }, - "OperationProperties": { - "description": "Additional details about an operation.", - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "serviceSpecification": { - "description": "Details about a service operation.", - "$ref": "#/definitions/OperationServiceSpecification" - } - } - }, - "OperationServiceSpecification": { - "description": "Details about a service operation.", - "type": "object", - "properties": { - "logSpecifications": { - "description": "Details about operations related to logs.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationLogSpecification" - } - }, - "metricSpecifications": { - "description": "Details about operations related to metrics.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricSpecification" - } - } - } - }, - "OperationLogSpecification": { - "description": "Details about an operation related to logs.", - "type": "object", - "properties": { - "name": { - "description": "The name of the log category.", - "type": "string" - }, - "displayName": { - "description": "Localized display name.", - "type": "string" - }, - "blobDuration": { - "description": "Blobs created in the customer storage account, per hour.", - "type": "string" - } - } - }, - "OperationMetricSpecification": { - "description": "Details about an operation related to metrics.", - "type": "object", - "properties": { - "name": { - "description": "The name of the metric.", - "type": "string" - }, - "displayName": { - "description": "Localized display name of the metric.", - "type": "string" - }, - "displayDescription": { - "description": "The description of the metric.", - "type": "string" - }, - "unit": { - "description": "The unit that the metric is measured in.", - "type": "string" - }, - "aggregationType": { - "description": "The type of metric aggregation.", - "type": "string" - }, - "enableRegionalMdmAccount": { - "description": "Whether or not the service is using regional MDM accounts.", - "type": "string" - }, - "sourceMdmAccount": { - "description": "The name of the MDM account.", - "type": "string" - }, - "sourceMdmNamespace": { - "description": "The name of the MDM namespace.", - "type": "string" - }, - "availabilities": { - "description": "Defines how often data for metrics becomes available.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricAvailability" - } - } - } - }, - "OperationMetricAvailability": { - "description": "Defines how often data for a metric becomes available.", - "type": "object", - "properties": { - "timeGrain": { - "description": "The granularity for the metric.", - "type": "string" - }, - "blobDuration": { - "description": "Blob created in the customer storage account, per hour.", - "type": "string" - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription identifier.", - "in": "path", - "required": true, - "type": "string" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "description": "The resource group name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "factoryName": { - "name": "factoryName", - "description": "The factory name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", - "minLength": 3, - "maxLength": 63, - "x-ms-parameter-location": "method" - }, - "locationId": { - "name": "locationId", - "description": "The location identifier.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "linkedServiceName": { - "name": "linkedServiceName", - "description": "The linked service name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", - "minLength": 1, - "maxLength": 260, - "x-ms-parameter-location": "method" - }, - "datasetName": { - "name": "datasetName", - "description": "The dataset name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", - "minLength": 1, - "maxLength": 260, - "x-ms-parameter-location": "method" - }, - "pipelineName": { - "name": "pipelineName", - "description": "The pipeline name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", - "minLength": 1, - "maxLength": 260, - "x-ms-parameter-location": "method" - }, - "triggerName": { - "name": "triggerName", - "description": "The trigger name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", - "minLength": 1, - "maxLength": 260, - "x-ms-parameter-location": "method" - }, - "runId": { - "name": "runId", - "description": "The pipeline run identifier.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "referencePipelineRunId": { - "name": "referencePipelineRunId", - "description": "The pipeline run identifier.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "integrationRuntimeName": { - "name": "integrationRuntimeName", - "description": "The integration runtime name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", - "minLength": 3, - "maxLength": 63, - "x-ms-parameter-location": "method" - }, - "nodeName": { - "name": "nodeName", - "description": "The integration runtime node name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", - "minLength": 1, - "maxLength": 150, - "x-ms-parameter-location": "method" - }, - "api-version": { - "name": "api-version", - "description": "The API version.", - "in": "query", - "required": true, - "type": "string" - } - } - } +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-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": { + "/providers/Microsoft.DataFactory/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "description": "Lists the available Azure Data Factory API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/factories": { + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_List", + "x-ms-examples": { + "Factories_List": { + "$ref": "./examples/Factories_List.json" + } + }, + "description": "Lists factories under the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/FactoryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo": { + "post": { + "tags": [ + "configureFactoryRepo" + ], + "operationId": "Factories_ConfigureFactoryRepo", + "x-ms-examples": { + "Factories_ConfigureFactoryRepo": { + "$ref": "./examples/Factories_ConfigureFactoryRepo.json" + } + }, + "description": "Updates a factory's repo information.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factoryRepoUpdate", + "description": "Update factory repo request definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FactoryRepoUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories": { + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_ListByResourceGroup", + "x-ms-examples": { + "Factories_ListByResourceGroup": { + "$ref": "./examples/Factories_ListByResourceGroup.json" + } + }, + "description": "Lists factories.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/FactoryListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}": { + "put": { + "tags": [ + "factories" + ], + "operationId": "Factories_CreateOrUpdate", + "x-ms-examples": { + "Factories_CreateOrUpdate": { + "$ref": "./examples/Factories_CreateOrUpdate.json" + } + }, + "description": "Creates or updates a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factory", + "description": "Factory resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Factory" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "factories" + ], + "operationId": "Factories_Update", + "x-ms-examples": { + "Factories_Update": { + "$ref": "./examples/Factories_Update.json" + } + }, + "description": "Updates a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "factoryUpdateParameters", + "description": "The parameters for updating a factory.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FactoryUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "factories" + ], + "operationId": "Factories_Get", + "x-ms-examples": { + "Factories_Get": { + "$ref": "./examples/Factories_Get.json" + } + }, + "description": "Gets a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Factory" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "factories" + ], + "operationId": "Factories_Delete", + "x-ms-examples": { + "Factories_Delete": { + "$ref": "./examples/Factories_Delete.json" + } + }, + "description": "Deletes a factory.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes": { + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListByFactory", + "x-ms-examples": { + "IntegrationRuntimes_ListByFactory": { + "$ref": "./examples/IntegrationRuntimes_ListByFactory.json" + } + }, + "description": "Lists integration runtimes.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}": { + "put": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_CreateOrUpdate", + "x-ms-examples": { + "IntegrationRuntimes_Create": { + "$ref": "./examples/IntegrationRuntimes_Create.json" + } + }, + "description": "Creates or updates an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "integrationRuntime", + "description": "Integration runtime resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "An error response received from PUT integration runtime operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Get", + "x-ms-examples": { + "IntegrationRuntimes_Get": { + "$ref": "./examples/IntegrationRuntimes_Get.json" + } + }, + "description": "Gets an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "default": { + "description": "An error response received from GET integration runtime operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Update", + "x-ms-examples": { + "IntegrationRuntimes_Update": { + "$ref": "./examples/IntegrationRuntimes_Update.json" + } + }, + "description": "Updates an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "updateIntegrationRuntimeRequest", + "description": "The parameters for updating an integration runtime.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Delete", + "x-ms-examples": { + "IntegrationRuntimes_Delete": { + "$ref": "./examples/IntegrationRuntimes_Delete.json" + } + }, + "description": "Deletes an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from DELETE integration runtime operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetStatus", + "x-ms-examples": { + "IntegrationRuntimes_GetStatus": { + "$ref": "./examples/IntegrationRuntimes_GetStatus.json" + } + }, + "description": "Gets detailed status information for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetConnectionInfo", + "x-ms-examples": { + "IntegrationRuntimes_GetConnectionInfo": { + "$ref": "./examples/IntegrationRuntimes_GetConnectionInfo.json" + } + }, + "description": "Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeConnectionInfo" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_RegenerateAuthKey", + "x-ms-examples": { + "IntegrationRuntimes_RegenerateAuthKey": { + "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" + } + }, + "description": "Regenerates the authentication key for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "regenerateKeyParameters", + "description": "The parameters for regenerating integration runtime authentication key.", + "in": "body", + "required": true, + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeRegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_ListAuthKeys", + "x-ms-examples": { + "IntegrationRuntimes_ListAuthKeys": { + "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" + } + }, + "description": "Retrieves the authentication keys for an integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAuthKeys" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Start", + "x-ms-examples": { + "IntegrationRuntimes_Start": { + "$ref": "./examples/IntegrationRuntimes_Start.json" + } + }, + "description": "Starts a ManagedReserved type integration runtime.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Stop", + "x-ms-examples": { + "IntegrationRuntimes_Stop": { + "$ref": "./examples/IntegrationRuntimes_Stop.json" + } + }, + "description": "Stops a ManagedReserved type integration runtime.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeNode": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_RemoveNode", + "x-ms-examples": { + "IntegrationRuntimes_RemoveNode": { + "$ref": "./examples/IntegrationRuntimes_RemoveNode.json" + } + }, + "description": "Remove a node from integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "removeNodeParameters", + "description": "The name of the node to be removed from an integration runtime.", + "in": "body", + "required": true, + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeRemoveNodeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_SyncCredentials", + "x-ms-examples": { + "IntegrationRuntimes_SyncCredentials": { + "$ref": "./examples/IntegrationRuntimes_SyncCredentials.json" + } + }, + "description": "Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_GetMonitoringData", + "x-ms-examples": { + "IntegrationRuntimes_GetMonitoringData": { + "$ref": "./examples/IntegrationRuntimes_GetMonitoringData.json" + } + }, + "description": "Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeMonitoringData" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade": { + "post": { + "tags": [ + "integrationRuntimes" + ], + "operationId": "IntegrationRuntimes_Upgrade", + "x-ms-examples": { + "IntegrationRuntimes_Upgrade": { + "$ref": "./examples/IntegrationRuntimes_Upgrade.json" + } + }, + "description": "Upgrade self-hosted integration runtime to latest version if availably.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { + "delete": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_Delete", + "x-ms-examples": { + "IntegrationRuntimesNodes_Delete": { + "$ref": "./examples/IntegrationRuntimeNodes_Delete.json" + } + }, + "description": "Deletes a self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_Update", + "x-ms-examples": { + "IntegrationRuntimeNodes_Update": { + "$ref": "./examples/IntegrationRuntimeNodes_Update.json" + } + }, + "description": "Updates a self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "updateIntegrationRuntimeNodeRequest", + "description": "The parameters for updating an integration runtime node.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateIntegrationRuntimeNodeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}/ipAddress": { + "post": { + "tags": [ + "integrationRuntimeNodes" + ], + "operationId": "IntegrationRuntimeNodes_GetIpAddress", + "x-ms-examples": { + "IntegrationRuntimeNodes_GetIpAddress": { + "$ref": "./examples/IntegrationRuntimeNodes_GetIpAddress.json" + } + }, + "description": "Get the IP address of self-hosted integration runtime node.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/nodeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeNodeIpAddress" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices": { + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_ListByFactory", + "x-ms-examples": { + "LinkedServices_ListByFactory": { + "$ref": "./examples/LinkedServices_ListByFactory.json" + } + }, + "description": "Lists linked services.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}": { + "put": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_CreateOrUpdate", + "x-ms-examples": { + "LinkedServices_Create": { + "$ref": "./examples/LinkedServices_Create.json" + }, + "LinkedServices_Update": { + "$ref": "./examples/LinkedServices_Update.json" + } + }, + "description": "Creates or updates a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the linkedService entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "linkedService", + "description": "Linked service resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_Get", + "x-ms-examples": { + "LinkedServices_Get": { + "$ref": "./examples/LinkedServices_Get.json" + } + }, + "description": "Gets a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "linkedServices" + ], + "operationId": "LinkedServices_Delete", + "x-ms-examples": { + "LinkedServices_Delete": { + "$ref": "./examples/LinkedServices_Delete.json" + } + }, + "description": "Deletes a linked service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/linkedServiceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets": { + "get": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_ListByFactory", + "x-ms-examples": { + "Datasets_ListByFactory": { + "$ref": "./examples/Datasets_ListByFactory.json" + } + }, + "description": "Lists datasets.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/datasets/{datasetName}": { + "put": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_CreateOrUpdate", + "x-ms-examples": { + "Datasets_Create": { + "$ref": "./examples/Datasets_Create.json" + }, + "Datasets_Update": { + "$ref": "./examples/Datasets_Update.json" + } + }, + "description": "Creates or updates a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "dataset", + "description": "Dataset resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_Get", + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Datasets_Get.json" + } + }, + "description": "Gets a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "datasets" + ], + "operationId": "Datasets_Delete", + "x-ms-examples": { + "Datasets_Delete": { + "$ref": "./examples/Datasets_Delete.json" + } + }, + "description": "Deletes a dataset.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/datasetName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines": { + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_ListByFactory", + "x-ms-examples": { + "Pipelines_ListByFactory": { + "$ref": "./examples/Pipelines_ListByFactory.json" + } + }, + "description": "Lists pipelines.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}": { + "put": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_CreateOrUpdate", + "x-ms-examples": { + "Pipelines_Create": { + "$ref": "./examples/Pipelines_Create.json" + }, + "Pipelines_Update": { + "$ref": "./examples/Pipelines_Update.json" + } + }, + "description": "Creates or updates a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the pipeline entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "pipeline", + "description": "Pipeline resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_Get", + "x-ms-examples": { + "Pipelines_Get": { + "$ref": "./examples/Pipelines_Get.json" + } + }, + "description": "Gets a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_Delete", + "x-ms-examples": { + "Pipelines_Delete": { + "$ref": "./examples/Pipelines_Delete.json" + } + }, + "description": "Deletes a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun": { + "post": { + "tags": [ + "pipelines" + ], + "operationId": "Pipelines_CreateRun", + "x-ms-examples": { + "Pipelines_CreateRun": { + "$ref": "./examples/Pipelines_CreateRun.json" + } + }, + "description": "Creates a run of a pipeline.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/pipelineName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "description": "Parameters of the pipeline run.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ParameterValueSpecification" + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "schema": { + "$ref": "#/definitions/CreateRunResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns": { + "post": { + "operationId": "PipelineRuns_QueryByFactory", + "x-ms-examples": { + "PipelineRuns_QueryByFactory": { + "$ref": "./examples/PipelineRuns_QueryByFactory.json" + } + }, + "description": "Query pipeline runs in the factory based on input filter conditions.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "filterParameters", + "description": "Parameters to filter the pipeline run.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PipelineRunFilterParameters" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRunQueryResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}": { + "get": { + "operationId": "PipelineRuns_Get", + "x-ms-examples": { + "PipelineRuns_Get": { + "$ref": "./examples/PipelineRuns_Get.json" + } + }, + "description": "Get a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/PipelineRun" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns": { + "get": { + "operationId": "ActivityRuns_ListByPipelineRun", + "x-ms-examples": { + "ActivityRuns_ListByPipelineRun": { + "$ref": "./examples/ActivityRuns_ListByPipelineRun.json" + } + }, + "description": "List activity runs based on input filter conditions.", + "tags": [ + "activityruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "startTime", + "description": "The start time of activity runs in ISO8601 format.", + "in": "query", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "description": "The end time of activity runs in ISO8601 format.", + "in": "query", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "status", + "description": "The status of the pipeline run.", + "type": "string", + "in": "query", + "required": false + }, + { + "name": "activityName", + "description": "The name of the activity.", + "type": "string", + "in": "query", + "required": false + }, + { + "name": "linkedServiceName", + "description": "The linked service name.", + "in": "query", + "required": false, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260 + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ActivityRunsListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}": { + "post": { + "operationId": "Factories_CancelPipelineRun", + "x-ms-examples": { + "Factories_CancelPipelineRun": { + "$ref": "./examples/Factories_CancelPipelineRun.json" + } + }, + "description": "Cancel a pipeline run by its run ID.", + "tags": [ + "pipelineruns" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Pipeline run has been canceled successfully. " + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers": { + "get": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_ListByFactory", + "x-ms-examples": { + "Triggers_ListByFactory": { + "$ref": "./examples/Triggers_ListByFactory.json" + } + }, + "description": "Lists triggers.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}": { + "put": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_CreateOrUpdate", + "x-ms-examples": { + "Triggers_Create": { + "$ref": "./examples/Triggers_Create.json" + }, + "Triggers_Update": { + "$ref": "./examples/Triggers_Update.json" + } + }, + "description": "Creates or updates a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the trigger entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." + }, + { + "name": "trigger", + "description": "Trigger resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "trigger" + ], + "operationId": "Triggers_Get", + "x-ms-examples": { + "Triggers_Get": { + "$ref": "./examples/Triggers_Get.json" + } + }, + "description": "Gets a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Delete", + "x-ms-examples": { + "Triggers_Delete": { + "$ref": "./examples/Triggers_Delete.json" + } + }, + "description": "Deletes a trigger.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/start": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Start", + "x-ms-examples": { + "Triggers_Start": { + "$ref": "./examples/Triggers_Start.json" + } + }, + "description": "Starts a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Trigger has been started successfully." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/stop": { + "post": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_Stop", + "x-ms-examples": { + "Triggers_Stop": { + "$ref": "./examples/Triggers_Stop.json" + } + }, + "description": "Stops a trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Trigger has been stopped successfully." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerruns": { + "get": { + "tags": [ + "triggers" + ], + "operationId": "Triggers_ListRuns", + "x-ms-examples": { + "Triggers_ListRuns": { + "$ref": "./examples/Triggers_ListRuns.json" + } + }, + "description": "List trigger runs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "startTime", + "description": "Start time for trigger runs.", + "type": "string", + "format": "date-time", + "in": "query", + "required": true + }, + { + "name": "endTime", + "description": "End time for trigger runs.", + "type": "string", + "format": "date-time", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/TriggerRunListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "x-ms-azure-resource": true, + "description": "Azure Data Factory top-level resource.", + "properties": { + "id": { + "type": "string", + "description": "The resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "SubResource": { + "description": "Azure Data Factory nested resource, which belongs to a factory.", + "properties": { + "id": { + "type": "string", + "description": "The resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The resource type.", + "readOnly": true + }, + "etag": { + "type": "string", + "description": "Etag identifies change in the resource.", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "Expression": { + "description": "Azure Data Factory expression definition.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Expression type.", + "enum": [ + "Expression" + ] + }, + "value": { + "type": "string", + "description": "Expression value." + } + }, + "required": [ + "type", + "value" + ] + }, + "SecureString": { + "x-ms-discriminator-value": "SecureString", + "description": "Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "value": { + "type": "string", + "description": "Value of secure string." + } + }, + "required": [ + "value" + ] + }, + "AzureKeyVaultSecretReference": { + "x-ms-discriminator-value": "AzureKeyVaultSecret", + "description": "Azure Key Vault secret reference.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretBase" + } + ], + "properties": { + "store": { + "description": "The Azure Key Vault linked service reference.", + "$ref": "#/definitions/LinkedServiceReference" + }, + "secretName": { + "type": "object", + "description": "The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string)." + }, + "secretVersion": { + "type": "object", + "description": "The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "store", + "secretName" + ] + }, + "SecretBase": { + "description": "The base definition of a secret type.", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "type" + ] + }, + "FactoryListResponse": { + "description": "A list of factory resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of factories.", + "items": { + "$ref": "#/definitions/Factory" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "IntegrationRuntimeListResponse": { + "description": "A list of integration runtime resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of integration runtimes.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "IntegrationRuntimeReference": { + "description": "Integration runtime reference type.", + "properties": { + "type": { + "type": "string", + "description": "Type of integration runtime.", + "enum": [ + "IntegrationRuntimeReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference integration runtime name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for integration runtime." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "IntegrationRuntimeResource": { + "description": "Integration runtime resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntime", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "IntegrationRuntimeStatusResponse": { + "description": "Integration runtime status response.", + "properties": { + "name": { + "type": "string", + "description": "The integration runtime name.", + "readOnly": true + }, + "properties": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeStatus", + "description": "Integration runtime properties." + } + }, + "required": [ + "properties" + ] + }, + "IntegrationRuntimeStatusListResponse": { + "description": "A list of integration runtime status.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of integration runtime status.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeStatusResponse" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "UpdateIntegrationRuntimeRequest": { + "description": "Update integration runtime request.", + "type": "object", + "properties": { + "autoUpdate": { + "description": "Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189.", + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/IntegrationRuntimeAutoUpdate" + }, + "updateDelayOffset": { + "description": "The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.", + "type": "string" + } + } + }, + "UpdateIntegrationRuntimeNodeRequest": { + "description": "Update integration runtime node request.", + "type": "object", + "properties": { + "concurrentJobsLimit": { + "description": "The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.", + "type": "integer", + "minimum": 1 + } + } + }, + "LinkedServiceListResponse": { + "description": "A list of linked service resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of linked services.", + "items": { + "$ref": "#/definitions/LinkedServiceResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "DatasetListResponse": { + "description": "A list of dataset resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of datasets.", + "items": { + "$ref": "#/definitions/DatasetResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "PipelineListResponse": { + "description": "A list of pipeline resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipelines.", + "items": { + "$ref": "#/definitions/PipelineResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "TriggerListResponse": { + "description": "A list of trigger resources.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of triggers.", + "items": { + "$ref": "#/definitions/TriggerResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "CreateRunResponse": { + "description": "Response body with a run identifier.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string" + } + }, + "required": [ + "runId" + ] + }, + "ErrorResponse": { + "description": "The object that defines the structure of an Azure Data Factory response.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Property name/path in request associated with error.", + "type": "string" + }, + "details": { + "description": "Array with additional error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ParameterDefinitionSpecification": { + "description": "Definition of all parameters for an entity.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ParameterSpecification" + } + }, + "ParameterSpecification": { + "description": "Definition of a single parameter for an entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Parameter type.", + "enum": [ + "Object", + "String", + "Int", + "Float", + "Bool", + "Array", + "SecureString" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true + } + }, + "defaultValue": { + "type": "object", + "description": "Default value of parameter." + } + }, + "required": [ + "type" + ] + }, + "ParameterValueSpecification": { + "description": "An object mapping parameter names to argument values.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "FactoryVSTSConfiguration": { + "description": "Factory's VSTS repo information.", + "properties": { + "accountName": { + "description": "VSTS account name.", + "type": "string" + }, + "projectName": { + "description": "VSTS project name.", + "type": "string" + }, + "repositoryName": { + "description": "VSTS repository name.", + "type": "string" + }, + "collaborationBranch": { + "description": "VSTS collaboration branch.", + "type": "string" + }, + "rootFolder": { + "description": "VSTS root folder.", + "type": "string" + }, + "lastCommitId": { + "description": "VSTS last commit id.", + "type": "string" + }, + "tenantId": { + "description": "VSTS tenant id.", + "type": "string" + } + } + }, + "FactoryRepoUpdate": { + "description": "Factory's VSTS repo information.", + "properties": { + "factoryResourceId": { + "description": "The factory resource id.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name.", + "type": "string" + }, + "vstsConfiguration": { + "$ref": "#/definitions/FactoryVSTSConfiguration", + "description": "VSTS repo information of the factory." + } + } + }, + "FactoryProperties": { + "description": "Factory resource properties.", + "properties": { + "provisioningState": { + "description": "Factory provisioning state, example Succeeded.", + "type": "string", + "readOnly": true + }, + "createTime": { + "description": "Time the factory was created in ISO8601 format.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "version": { + "description": "Version of the factory.", + "type": "string", + "readOnly": true + }, + "vstsConfiguration": { + "$ref": "#/definitions/FactoryVSTSConfiguration", + "description": "VSTS repo information of the factory." + } + } + }, + "PipelineResource": { + "description": "Pipeline resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "./entityTypes/Pipeline.json#/definitions/Pipeline", + "description": "Properties of the pipeline." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "properties" + ] + }, + "PipelineReference": { + "description": "Pipeline reference type.", + "properties": { + "type": { + "type": "string", + "description": "Pipeline reference type.", + "enum": [ + "PipelineReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference pipeline name." + }, + "name": { + "type": "string", + "description": "Reference name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "TriggerPipelineReference": { + "description": "Pipeline that needs to be triggered with the given parameters.", + "properties": { + "pipelineReference": { + "description": "Pipeline reference.", + "$ref": "#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "#/definitions/ParameterValueSpecification" + } + } + }, + "TriggerResource": { + "description": "Trigger resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Trigger.json#/definitions/Trigger", + "description": "Properties of the trigger." + } + }, + "required": [ + "properties" + ] + }, + "Factory": { + "description": "Factory resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/FactoryIdentity", + "description": "Managed service identity of the factory." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FactoryProperties", + "description": "Properties of the factory." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "FactoryUpdateParameters": { + "description": "Parameters for updating a factory resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "identity": { + "$ref": "#/definitions/FactoryIdentity", + "description": "Managed service identity of the factory." + } + } + }, + "FactoryIdentity": { + "description": "Identity properties of the factory resource.", + "properties": { + "type": { + "type": "string", + "description": "The identity type. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "FactoryIdentityType", + "modelAsString": false + } + }, + "principalId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The principal id of the identity." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The client tenant id of the identity." + } + }, + "required": [ + "type" + ] + }, + "DatasetReference": { + "description": "Dataset reference type.", + "properties": { + "type": { + "type": "string", + "description": "Dataset reference type.", + "enum": [ + "DatasetReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference dataset name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for dataset." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "DatasetResource": { + "description": "Dataset resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/Dataset.json#/definitions/Dataset", + "description": "Dataset properties." + } + }, + "required": [ + "properties" + ] + }, + "LinkedServiceReference": { + "description": "Linked service reference type.", + "properties": { + "type": { + "type": "string", + "description": "Linked service reference type.", + "enum": [ + "LinkedServiceReference" + ] + }, + "referenceName": { + "type": "string", + "description": "Reference LinkedService name." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueSpecification", + "description": "Arguments for LinkedService." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "LinkedServiceResource": { + "description": "Linked service resource type.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/LinkedService.json#/definitions/LinkedService", + "description": "Properties of linked service." + } + }, + "required": [ + "properties" + ] + }, + "PipelineRunFilterParameters": { + "description": "Query parameters for listing pipeline runs.", + "type": "object", + "properties": { + "continuationToken": { + "description": "The continuation token for getting the next page of results. Null for first page.", + "type": "string" + }, + "lastUpdatedAfter": { + "description": "The time at or after which the pipeline run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedBefore": { + "description": "The time at or before which the pipeline run event was updated in 'ISO 8601' format.", + "type": "string", + "format": "date-time" + }, + "filters": { + "type": "array", + "description": "List of filters.", + "items": { + "$ref": "#/definitions/PipelineRunQueryFilter" + } + }, + "orderBy": { + "type": "array", + "description": "List of OrderBy option.", + "items": { + "$ref": "#/definitions/PipelineRunQueryOrderBy" + } + } + }, + "required": [ + "lastUpdatedAfter", + "lastUpdatedBefore" + ] + }, + "PipelineRunQueryFilter": { + "description": "Query filter option for listing pipeline runs.", + "type": "object", + "properties": { + "operand": { + "description": "Parameter name to be used for filter.", + "type": "string", + "enum": [ + "PipelineName", + "Status", + "RunStart", + "RunEnd" + ], + "x-ms-enum": { + "name": "PipelineRunQueryFilterOperand", + "modelAsString": true + } + }, + "operator": { + "description": "Operator to be used for filter.", + "type": "string", + "enum": [ + "Equals", + "NotEquals", + "In", + "NotIn" + ], + "x-ms-enum": { + "name": "PipelineRunQueryFilterOperator", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "List of filter values.", + "items": { + "type": "string" + } + } + }, + "required": [ + "operand", + "operator", + "values" + ] + }, + "PipelineRunQueryOrderBy": { + "description": "An object to provide order by options for listing pipeline runs.", + "type": "object", + "properties": { + "orderBy": { + "description": "Parameter name to be used for order by.", + "type": "string", + "enum": [ + "RunStart", + "RunEnd" + ], + "x-ms-enum": { + "name": "PipelineRunQueryOrderByField", + "modelAsString": true + } + }, + "order": { + "description": "Sorting order of the parameter.", + "type": "string", + "enum": [ + "ASC", + "DESC" + ], + "x-ms-enum": { + "name": "PipelineRunQueryOrder", + "modelAsString": true + } + } + }, + "required": [ + "orderBy", + "order" + ] + }, + "PipelineRunQueryResponse": { + "description": "A list pipeline runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pipeline runs.", + "items": { + "$ref": "#/definitions/PipelineRun" + } + }, + "continuationToken": { + "description": "The continuation token for getting the next page of results, if any remaining results exist, null otherwise.", + "type": "string" + } + } + }, + "PipelineRun": { + "description": "Information about a pipeline run.", + "type": "object", + "properties": { + "runId": { + "description": "Identifier of a run.", + "type": "string", + "readOnly": true + }, + "pipelineName": { + "description": "The pipeline name.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The full or partial list of parameter name, value pair used in the pipeline run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "invokedBy": { + "description": "Entity that started the pipeline run.", + "$ref": "#/definitions/PipelineRunInvokedBy", + "readOnly": true + }, + "lastUpdated": { + "description": "The last updated timestamp for the pipeline run event in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runStart": { + "description": "The start time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "runEnd": { + "description": "The end time of a pipeline run in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of a pipeline run.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "The status of a pipeline run.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message from a pipeline run.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PipelineRunInvokedBy": { + "description": "Provides entity name and id that started the pipeline run.", + "type": "object", + "properties": { + "name": { + "description": "Name of the entity that started the pipeline run.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The ID of the entity that started the run.", + "type": "string", + "readOnly": true + } + } + }, + "ActivityRunsListResponse": { + "description": "A list activity runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of activity runs.", + "items": { + "$ref": "#/definitions/ActivityRun" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "ActivityRun": { + "description": "Information about an activity run in a pipeline.", + "type": "object", + "properties": { + "pipelineName": { + "description": "The name of the pipeline.", + "type": "string", + "readOnly": true + }, + "pipelineRunId": { + "description": "The id of the pipeline run.", + "type": "string", + "readOnly": true + }, + "activityName": { + "description": "The name of the activity.", + "type": "string", + "readOnly": true + }, + "activityType": { + "description": "The type of the activity.", + "type": "string", + "readOnly": true + }, + "activityRunId": { + "description": "The id of the activity run.", + "type": "string", + "readOnly": true + }, + "linkedServiceName": { + "description": "The name of the compute linked service.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the activity run.", + "type": "string", + "readOnly": true + }, + "activityRunStart": { + "description": "The start time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "activityRunEnd": { + "description": "The end time of the activity run in 'ISO 8601' format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "durationInMs": { + "description": "The duration of the activity run.", + "type": "integer", + "readOnly": true + }, + "input": { + "description": "The input for the activity.", + "type": "object", + "readOnly": true + }, + "output": { + "description": "The output for the activity.", + "type": "object", + "readOnly": true + }, + "error": { + "description": "The error if any from the activity run.", + "type": "object", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "TriggerRunListResponse": { + "description": "A list of trigger runs.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of trigger runs.", + "items": { + "$ref": "#/definitions/TriggerRun" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, + "TriggerRun": { + "description": "Trigger runs.", + "type": "object", + "properties": { + "triggerRunId": { + "type": "string", + "description": "Trigger run id.", + "readOnly": true + }, + "triggerName": { + "type": "string", + "description": "Trigger name.", + "readOnly": true + }, + "triggerType": { + "type": "string", + "description": "Trigger type.", + "readOnly": true + }, + "triggerRunTimestamp": { + "type": "string", + "format": "date-time", + "description": "Trigger run start time.", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Inprogress" + ], + "x-ms-enum": { + "name": "TriggerRunStatus", + "modelAsString": true + }, + "description": "Trigger run status.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Trigger error message.", + "readOnly": true + }, + "properties": { + "description": "List of property name and value related to trigger run. Name, value pair depends on type of trigger.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "triggeredPipelines": { + "description": "List of pipeline name and run Id triggered by the trigger run.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "OperationListResponse": { + "description": "A list of operations that can be performed by the Data Factory service.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Data Factory operations supported by the Data Factory resource provider." + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of results, if any remaining results exist." + } + } + }, + "Operation": { + "description": "Azure Data Factory API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "origin": { + "description": "The intended executor of the operation.", + "type": "string" + }, + "display": { + "description": "Metadata associated with the operation.", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "provider": { + "description": "The name of the provider.", + "type": "string" + }, + "resource": { + "description": "The name of the resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The type of operation: get, read, delete, etc.", + "type": "string" + } + } + }, + "properties": { + "description": "Additional details about the operation.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Additional details about an operation.", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "serviceSpecification": { + "description": "Details about a service operation.", + "$ref": "#/definitions/OperationServiceSpecification" + } + } + }, + "OperationServiceSpecification": { + "description": "Details about a service operation.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Details about operations related to logs.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationLogSpecification" + } + }, + "metricSpecifications": { + "description": "Details about operations related to metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricSpecification" + } + } + } + }, + "OperationLogSpecification": { + "description": "Details about an operation related to logs.", + "type": "object", + "properties": { + "name": { + "description": "The name of the log category.", + "type": "string" + }, + "displayName": { + "description": "Localized display name.", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in the customer storage account, per hour.", + "type": "string" + } + } + }, + "OperationMetricSpecification": { + "description": "Details about an operation related to metrics.", + "type": "object", + "properties": { + "name": { + "description": "The name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "The description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that the metric is measured in.", + "type": "string" + }, + "aggregationType": { + "description": "The type of metric aggregation.", + "type": "string" + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "string" + }, + "sourceMdmAccount": { + "description": "The name of the MDM account.", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "The name of the MDM namespace.", + "type": "string" + }, + "availabilities": { + "description": "Defines how often data for metrics becomes available.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricAvailability" + } + } + } + }, + "OperationMetricAvailability": { + "description": "Defines how often data for a metric becomes available.", + "type": "object", + "properties": { + "timeGrain": { + "description": "The granularity for the metric.", + "type": "string" + }, + "blobDuration": { + "description": "Blob created in the customer storage account, per hour.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "The subscription identifier.", + "in": "path", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "factoryName": { + "name": "factoryName", + "description": "The factory name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "locationId": { + "name": "locationId", + "description": "The location identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "linkedServiceName": { + "name": "linkedServiceName", + "description": "The linked service name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "datasetName": { + "name": "datasetName", + "description": "The dataset name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "pipelineName": { + "name": "pipelineName", + "description": "The pipeline name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "triggerName": { + "name": "triggerName", + "description": "The trigger name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" + }, + "runId": { + "name": "runId", + "description": "The pipeline run identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "referencePipelineRunId": { + "name": "referencePipelineRunId", + "description": "The pipeline run identifier.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "integrationRuntimeName": { + "name": "integrationRuntimeName", + "description": "The integration runtime name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + }, + "nodeName": { + "name": "nodeName", + "description": "The integration runtime node name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$", + "minLength": 1, + "maxLength": 150, + "x-ms-parameter-location": "method" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } + } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json index 466c05c5a2fc..dc0d8a5a08e2 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json @@ -1,1444 +1,1444 @@ -{ - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2017-09-01-preview" - }, - "paths": {}, - "definitions": { - "Dataset": { - "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "Type of dataset." - }, - "description": { - "description": "Dataset description.", - "type": "string" - }, - "structure": { - "type": "object", - "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." - }, - "linkedServiceName": { - "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", - "description": "Parameters for dataset." - }, - "annotations": { - "description": "List of tags that can be used for describing the Dataset.", - "type": "array", - "items": { - "type": "object" - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type", - "linkedServiceName" - ] - }, - "DatasetDataElement": { - "description": "Columns that define the structure of the dataset.", - "type": "object", - "properties": { - "name": { - "type": "object", - "description": "Name of the column. Type: string (or Expression with resultType string)." - }, - "type": { - "type": "object", - "description": "Type of the column. Type: string (or Expression with resultType string)." - } - } - }, - "DatasetStorageFormat": { - "discriminator": "type", - "description": "The format definition of a storage.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of dataset storage format." - }, - "serializer": { - "type": "object", - "description": "Serializer. Type: string (or Expression with resultType string)." - }, - "deserializer": { - "type": "object", - "description": "Deserializer. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "TextFormat": { - "description": "The data stored in text format.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetStorageFormat" - } - ], - "properties": { - "columnDelimiter": { - "type": "object", - "description": "The column delimiter. Type: string (or Expression with resultType string)." - }, - "rowDelimiter": { - "type": "object", - "description": "The row delimiter. Type: string (or Expression with resultType string)." - }, - "escapeChar": { - "type": "object", - "description": "The escape character. Type: string (or Expression with resultType string)." - }, - "quoteChar": { - "type": "object", - "description": "The quote character. Type: string (or Expression with resultType string)." - }, - "nullValue": { - "type": "object", - "description": "The null value string. Type: string (or Expression with resultType string)." - }, - "encodingName": { - "type": "object", - "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." - }, - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." - }, - "skipLineCount": { - "type": "object", - "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." - }, - "firstRowAsHeader": { - "type": "object", - "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "JsonFormat": { - "description": "The data stored in JSON format.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetStorageFormat" - } - ], - "properties": { - "filePattern": { - "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.", - "$ref": "#/definitions/JsonFormatFilePattern" - }, - "nestingSeparator": { - "type": "object", - "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." - }, - "encodingName": { - "type": "object", - "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." - }, - "jsonNodeReference": { - "type": "object", - "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." - }, - "jsonPathDefinition": { - "type": "object", - "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." - } - } - }, - "JsonFormatFilePattern": { - "description": "JSON format file pattern. A property of JsonFormat.", - "type": "string", - "enum": [ - "setOfObjects", - "arrayOfObjects" - ], - "x-ms-enum": { - "name": "JsonFormatFilePattern", - "modelAsString": true - } - }, - "AvroFormat": { - "description": "The data stored in Avro format.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetStorageFormat" - } - ] - }, - "OrcFormat": { - "description": "The data stored in Optimized Row Columnar (ORC) format.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetStorageFormat" - } - ] - }, - "ParquetFormat": { - "description": "The data stored in Parquet format.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetStorageFormat" - } - ] - }, - "DatasetCompression": { - "discriminator": "type", - "description": "The compression method used on a dataset.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of dataset compression." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "DatasetBZip2Compression": { - "x-ms-discriminator-value": "BZip2", - "description": "The BZip2 compression method used on a dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetCompression" - } - ], - "properties": {} - }, - "DatasetGZipCompression": { - "x-ms-discriminator-value": "GZip", - "description": "The GZip compression method used on a dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetCompression" - } - ], - "properties": { - "level": { - "description": "The GZip compression level.", - "$ref": "#/definitions/CompressionLevel" - } - } - }, - "DatasetDeflateCompression": { - "x-ms-discriminator-value": "Deflate", - "description": "The Deflate compression method used on a dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetCompression" - } - ], - "properties": { - "level": { - "description": "The Deflate compression level.", - "$ref": "#/definitions/CompressionLevel" - } - } - }, - "DatasetZipDeflateCompression": { - "x-ms-discriminator-value": "ZipDeflate", - "description": "The ZipDeflate compression method used on a dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DatasetCompression" - } - ], - "properties": { - "level": { - "description": "The ZipDeflate compression level.", - "$ref": "#/definitions/CompressionLevel" - } - } - }, - "CompressionLevel": { - "title": "Microsoft.Azure.Management.DataFactories.Models.CompressionLevel", - "description": "All available compression levels.", - "type": "string", - "enum": [ - "Optimal", - "Fastest" - ], - "x-ms-enum": { - "name": "DatasetCompressionLevel", - "modelAsString": true - } - }, - "AmazonS3Dataset": { - "x-ms-discriminator-value": "AmazonS3Object", - "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Amazon S3 dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AmazonS3DatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AmazonS3DatasetTypeProperties": { - "description": "Amazon S3 dataset properties.", - "properties": { - "bucketName": { - "type": "object", - "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." - }, - "key": { - "type": "object", - "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." - }, - "prefix": { - "type": "object", - "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." - }, - "version": { - "type": "object", - "description": "The version for the S3 object. Type: string (or Expression with resultType string)." - }, - "format": { - "description": "The format of files.", - "$ref": "#/definitions/DatasetStorageFormat" - }, - "compression": { - "description": "The data compression method used for the Amazon S3 object.", - "$ref": "#/definitions/DatasetCompression" - } - }, - "required": [ - "bucketName" - ] - }, - "AzureBlobDataset": { - "x-ms-discriminator-value": "AzureBlob", - "description": "The Azure Blob storage.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Blob dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureBlobDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureBlobDatasetTypeProperties": { - "description": "Azure Blob dataset properties.", - "properties": { - "folderPath": { - "type": "object", - "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." - }, - "tableRootLocation": { - "type": "object", - "description": "The root of blob path. Type: string (or Expression with resultType string)." - }, - "fileName": { - "type": "object", - "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." - }, - "format": { - "description": "The format of the Azure Blob storage.", - "$ref": "#/definitions/DatasetStorageFormat" - }, - "compression": { - "description": "The data compression method used for the blob storage.", - "$ref": "#/definitions/DatasetCompression" - } - } - }, - "AzureTableDataset": { - "x-ms-discriminator-value": "AzureTable", - "description": "The Azure Table storage dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Table dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureTableDatasetTypeProperties": { - "description": "Azure Table dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "tableName" - ] - }, - "AzureSqlTableDataset": { - "x-ms-discriminator-value": "AzureSqlTable", - "description": "The Azure SQL Server database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure SQL dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureSqlTableDatasetTypeProperties": { - "description": "Azure SQL dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "tableName" - ] - }, - "AzureSqlDWTableDataset": { - "x-ms-discriminator-value": "AzureSqlDWTable", - "description": "The Azure SQL Data Warehouse dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure SQL Data Warehouse dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureSqlDWTableDatasetTypeProperties": { - "description": "Azure SQL Data Warehouse dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "tableName" - ] - }, - "CassandraTableDataset": { - "x-ms-discriminator-value": "CassandraTable", - "description": "The Cassandra database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Cassandra dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/CassandraTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "CassandraTableDatasetTypeProperties": { - "description": "Cassandra dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." - }, - "keyspace": { - "type": "object", - "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." - } - } - }, - "CustomDataset": { - "description": "The custom dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Custom dataset properties.", - "x-ms-client-flatten": true, - "type": "object" - } - }, - "required": [ - "typeProperties" - ] - }, - "DocumentDbCollectionDataset": { - "x-ms-discriminator-value": "DocumentDbCollection", - "description": "Microsoft Azure Document Database Collection dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "DocumentDB Collection dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DocumentDbCollectionDatasetTypeProperties": { - "description": "DocumentDB Collection dataset properties.", - "properties": { - "collectionName": { - "type": "object", - "description": "Document Database collection name. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "collectionName" - ] - }, - "DynamicsEntityDataset": { - "x-ms-discriminator-value": "DynamicsEntity", - "description": "The Dynamics entity dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Dynamics entity dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DynamicsEntityDatasetTypeProperties": { - "description": "Dynamics entity dataset properties.", - "properties": { - "entityName": { - "type": "object", - "description": "The logical name of the entity. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreDataset": { - "x-ms-discriminator-value": "AzureDataLakeStoreFile", - "description": "Azure Data Lake Store dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure Data Lake Store dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureDataLakeStoreDatasetTypeProperties": { - "description": "Azure Data Lake Store dataset properties.", - "properties": { - "folderPath": { - "type": "object", - "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." - }, - "fileName": { - "type": "object", - "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." - }, - "format": { - "description": "The format of the Data Lake Store.", - "$ref": "#/definitions/DatasetStorageFormat" - }, - "compression": { - "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", - "$ref": "#/definitions/DatasetCompression" - } - }, - "required": [ - "folderPath" - ] - }, - "FileShareDataset": { - "x-ms-discriminator-value": "FileShare", - "description": "An on-premises file system dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "On-premises file system dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FileShareDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "FileShareDatasetTypeProperties": { - "description": "On-premises file system dataset properties.", - "properties": { - "folderPath": { - "type": "object", - "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." - }, - "fileName": { - "type": "object", - "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." - }, - "format": { - "description": "The format of the files.", - "$ref": "#/definitions/DatasetStorageFormat" - }, - "fileFilter": { - "type": "object", - "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." - }, - "compression": { - "description": "The data compression method used for the file system.", - "$ref": "#/definitions/DatasetCompression" - } - } - }, - "MongoDbCollectionDataset": { - "x-ms-discriminator-value": "MongoDbCollection", - "description": "The MongoDB database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "MongoDB database dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "MongoDbCollectionDatasetTypeProperties": { - "description": "MongoDB database dataset properties.", - "properties": { - "collectionName": { - "type": "object", - "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "collectionName" - ] - }, - "ODataResourceDataset": { - "x-ms-discriminator-value": "ODataResource", - "description": "The Open Data Protocol (OData) resource dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "OData dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ODataResourceDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ODataResourceDatasetTypeProperties": { - "description": "OData dataset properties.", - "properties": { - "path": { - "type": "object", - "description": "The OData resource path. Type: string (or Expression with resultType string)." - } - } - }, - "OracleTableDataset": { - "x-ms-discriminator-value": "OracleTable", - "description": "The on-premises Oracle database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "On-premises Oracle dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/OracleTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "OracleTableDatasetTypeProperties": { - "description": "On-premises Oracle dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "tableName" - ] - }, - "AzureMySqlTableDataset": { - "x-ms-discriminator-value": "AzureMySqlTable", - "description": "The Azure MySQL database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Azure MySQL database dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMySqlTableDatasetTypeProperties": { - "description": "Azure MySQL database dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." - } - } - }, - "RelationalTableDataset": { - "x-ms-discriminator-value": "RelationalTable", - "description": "The relational table dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Relational table dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RelationalTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "RelationalTableDatasetTypeProperties": { - "description": "Relational table dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The relational table name. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceObjectDataset": { - "x-ms-discriminator-value": "SalesforceObject", - "description": "The Salesforce object dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Salesforce object dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SalesforceObjectDatasetTypeProperties": { - "description": "Salesforce object dataset properties.", - "properties": { - "objectApiName": { - "type": "object", - "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." - } - } - }, - "SapCloudForCustomerResourceDataset": { - "x-ms-discriminator-value": "SapCloudForCustomerResource", - "description": "The path of the SAP Cloud for Customer OData entity.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "SAP Cloud For Customer OData resource dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SapCloudForCustomerResourceDatasetTypeProperties": { - "description": "Sap Cloud For Customer OData resource dataset properties.", - "properties": { - "path": { - "type": "object", - "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "path" - ] - }, - "SapEccResourceDataset": { - "x-ms-discriminator-value": "SapEccResource", - "description": "The path of the SAP ECC OData entity.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "SAP ECC OData resource dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SapEccResourceDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SapEccResourceDatasetTypeProperties": { - "description": "Sap ECC OData resource dataset properties.", - "properties": { - "path": { - "type": "string", - "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "path" - ] - }, - "SqlServerTableDataset": { - "x-ms-discriminator-value": "SqlServerTable", - "description": "The on-premises SQL Server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "On-premises SQL Server dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SqlServerTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SqlServerTableDatasetTypeProperties": { - "description": "On-premises SQL Server dataset properties.", - "properties": { - "tableName": { - "type": "object", - "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "tableName" - ] - }, - "WebTableDataset": { - "x-ms-discriminator-value": "WebTable", - "description": "The dataset points to a HTML table in the web page.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Web table dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebTableDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebTableDatasetTypeProperties": { - "description": "Web table dataset properties.", - "properties": { - "index": { - "type": "object", - "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "path": { - "type": "object", - "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "index" - ] - }, - "AzureSearchIndexDataset": { - "x-ms-discriminator-value": "AzureSearchIndex", - "description": "The Azure Search Index.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Properties specific to this dataset type.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureSearchIndexDatasetTypeProperties": { - "description": "Properties specific to this dataset type.", - "properties": { - "indexName": { - "type": "object", - "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "indexName" - ] - }, - "HttpDataset": { - "x-ms-discriminator-value": "HttpFile", - "description": "A file in an HTTP web server.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Properties specific to this dataset type.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HttpDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HttpDatasetTypeProperties": { - "description": "Properties specific to this dataset type.", - "properties": { - "relativeUrl": { - "type": "object", - "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." - }, - "requestMethod": { - "type": "object", - "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\r\n...\r\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." - }, - "format": { - "description": "The format of files.", - "$ref": "#/definitions/DatasetStorageFormat" - }, - "compression": { - "description": "The data compression method used on files.", - "$ref": "#/definitions/DatasetCompression" - } - } - }, - "AmazonMWSObjectDataset" : { - "x-ms-discriminator-value": "AmazonMWSObject", - "description": "Amazon Marketplace Web Service dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "AzurePostgreSqlTableDataset" : { - "x-ms-discriminator-value": "AzurePostgreSqlTable", - "description": "Azure PostgreSQL dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ConcurObjectDataset" : { - "x-ms-discriminator-value": "ConcurObject", - "description": "Concur Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "CouchbaseTableDataset" : { - "x-ms-discriminator-value": "CouchbaseTable", - "description": "Couchbase server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "DrillTableDataset" : { - "x-ms-discriminator-value": "DrillTable", - "description": "Drill server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "EloquaObjectDataset" : { - "x-ms-discriminator-value": "EloquaObject", - "description": "Eloqua server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "GoogleBigQueryObjectDataset" : { - "x-ms-discriminator-value": "GoogleBigQueryObject", - "description": "Google BigQuery service dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "GreenplumTableDataset" : { - "x-ms-discriminator-value": "GreenplumTable", - "description": "Greenplum Database dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "HBaseObjectDataset" : { - "x-ms-discriminator-value": "HBaseObject", - "description": "HBase server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "HiveObjectDataset" : { - "x-ms-discriminator-value": "HiveObject", - "description": "Hive Server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "HubspotObjectDataset" : { - "x-ms-discriminator-value": "HubspotObject", - "description": "Hubspot Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ImpalaObjectDataset" : { - "x-ms-discriminator-value": "ImpalaObject", - "description": "Impala server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "JiraObjectDataset" : { - "x-ms-discriminator-value": "JiraObject", - "description": "Jira Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "MagentoObjectDataset" : { - "x-ms-discriminator-value": "MagentoObject", - "description": "Magento server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "MariaDBTableDataset" : { - "x-ms-discriminator-value": "MariaDBTable", - "description": "MariaDB server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "MarketoObjectDataset" : { - "x-ms-discriminator-value": "MarketoObject", - "description": "Marketo server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "PaypalObjectDataset" : { - "x-ms-discriminator-value": "PaypalObject", - "description": "Paypal Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "PhoenixObjectDataset" : { - "x-ms-discriminator-value": "PhoenixObject", - "description": "Phoenix server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "PrestoObjectDataset" : { - "x-ms-discriminator-value": "PrestoObject", - "description": "Presto server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "QuickBooksObjectDataset" : { - "x-ms-discriminator-value": "QuickBooksObject", - "description": "QuickBooks server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ServiceNowObjectDataset" : { - "x-ms-discriminator-value": "ServiceNowObject", - "description": "ServiceNow server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ShopifyObjectDataset" : { - "x-ms-discriminator-value": "ShopifyObject", - "description": "Shopify Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "SparkObjectDataset" : { - "x-ms-discriminator-value": "SparkObject", - "description": "Spark Server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "SquareObjectDataset" : { - "x-ms-discriminator-value": "SquareObject", - "description": "Square Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "XeroObjectDataset" : { - "x-ms-discriminator-value": "XeroObject", - "description": "Xero Serivce dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ZohoObjectDataset" : { - "x-ms-discriminator-value": "ZohoObject", - "description": "Zoho server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "NetezzaTableDataset" : { - "x-ms-discriminator-value": "NetezzaTable", - "description": "Netezza dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "VerticaTableDataset" : { - "x-ms-discriminator-value": "VerticaTable", - "description": "Vertica dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "SalesforceMarketingCloudObjectDataset": { - "x-ms-discriminator-value": "SalesforceMarketingCloudObject", - "description": "Salesforce Marketing Cloud dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "ResponsysObjectDataset": { - "x-ms-discriminator-value": "ResponsysObject", - "description": "Responsys dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Dataset": { + "description": "The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset." + }, + "description": { + "description": "Dataset description.", + "type": "string" + }, + "structure": { + "type": "object", + "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." + }, + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "Parameters for dataset." + }, + "annotations": { + "description": "List of tags that can be used for describing the Dataset.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type", + "linkedServiceName" + ] + }, + "DatasetDataElement": { + "description": "Columns that define the structure of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the column. Type: string (or Expression with resultType string)." + } + } + }, + "DatasetStorageFormat": { + "discriminator": "type", + "description": "The format definition of a storage.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset storage format." + }, + "serializer": { + "type": "object", + "description": "Serializer. Type: string (or Expression with resultType string)." + }, + "deserializer": { + "type": "object", + "description": "Deserializer. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TextFormat": { + "description": "The data stored in text format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "columnDelimiter": { + "type": "object", + "description": "The column delimiter. Type: string (or Expression with resultType string)." + }, + "rowDelimiter": { + "type": "object", + "description": "The row delimiter. Type: string (or Expression with resultType string)." + }, + "escapeChar": { + "type": "object", + "description": "The escape character. Type: string (or Expression with resultType string)." + }, + "quoteChar": { + "type": "object", + "description": "The quote character. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "skipLineCount": { + "type": "object", + "description": "The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer)." + }, + "firstRowAsHeader": { + "type": "object", + "description": "When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "JsonFormat": { + "description": "The data stored in JSON format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ], + "properties": { + "filePattern": { + "description": "File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.", + "$ref": "#/definitions/JsonFormatFilePattern" + }, + "nestingSeparator": { + "type": "object", + "description": "The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string)." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string)." + }, + "jsonNodeReference": { + "type": "object", + "description": "The JSONPath of the JSON array element to be flattened. Example: \"$.ArrayPath\". Type: string (or Expression with resultType string)." + }, + "jsonPathDefinition": { + "type": "object", + "description": "The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with \"$\"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {\"Column1\": \"$.Column1Path\", \"Column2\": \"Column2PathInArray\"}. Type: object (or Expression with resultType object)." + } + } + }, + "JsonFormatFilePattern": { + "description": "JSON format file pattern. A property of JsonFormat.", + "type": "string", + "enum": [ + "setOfObjects", + "arrayOfObjects" + ], + "x-ms-enum": { + "name": "JsonFormatFilePattern", + "modelAsString": true + } + }, + "AvroFormat": { + "description": "The data stored in Avro format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "OrcFormat": { + "description": "The data stored in Optimized Row Columnar (ORC) format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "ParquetFormat": { + "description": "The data stored in Parquet format.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetStorageFormat" + } + ] + }, + "DatasetCompression": { + "discriminator": "type", + "description": "The compression method used on a dataset.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of dataset compression." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "DatasetBZip2Compression": { + "x-ms-discriminator-value": "BZip2", + "description": "The BZip2 compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": {} + }, + "DatasetGZipCompression": { + "x-ms-discriminator-value": "GZip", + "description": "The GZip compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The GZip compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetDeflateCompression": { + "x-ms-discriminator-value": "Deflate", + "description": "The Deflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The Deflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "DatasetZipDeflateCompression": { + "x-ms-discriminator-value": "ZipDeflate", + "description": "The ZipDeflate compression method used on a dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DatasetCompression" + } + ], + "properties": { + "level": { + "description": "The ZipDeflate compression level.", + "$ref": "#/definitions/CompressionLevel" + } + } + }, + "CompressionLevel": { + "title": "Microsoft.Azure.Management.DataFactories.Models.CompressionLevel", + "description": "All available compression levels.", + "type": "string", + "enum": [ + "Optimal", + "Fastest" + ], + "x-ms-enum": { + "name": "DatasetCompressionLevel", + "modelAsString": true + } + }, + "AmazonS3Dataset": { + "x-ms-discriminator-value": "AmazonS3Object", + "description": "A single Amazon Simple Storage Service (S3) object or a set of S3 objects.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Amazon S3 dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AmazonS3DatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AmazonS3DatasetTypeProperties": { + "description": "Amazon S3 dataset properties.", + "properties": { + "bucketName": { + "type": "object", + "description": "The name of the Amazon S3 bucket. Type: string (or Expression with resultType string)." + }, + "key": { + "type": "object", + "description": "The key of the Amazon S3 object. Type: string (or Expression with resultType string)." + }, + "prefix": { + "type": "object", + "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." + }, + "version": { + "type": "object", + "description": "The version for the S3 object. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the Amazon S3 object.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "bucketName" + ] + }, + "AzureBlobDataset": { + "x-ms-discriminator-value": "AzureBlob", + "description": "The Azure Blob storage.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Blob dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBlobDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureBlobDatasetTypeProperties": { + "description": "Azure Blob dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the Azure Blob storage. Type: string (or Expression with resultType string)." + }, + "tableRootLocation": { + "type": "object", + "description": "The root of blob path. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Azure Blob storage.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the blob storage.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AzureTableDataset": { + "x-ms-discriminator-value": "AzureTable", + "description": "The Azure Table storage dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureTableDatasetTypeProperties": { + "description": "Azure Table dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure Table storage. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlTableDataset": { + "x-ms-discriminator-value": "AzureSqlTable", + "description": "The Azure SQL Server database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlTableDatasetTypeProperties": { + "description": "Azure SQL dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure SQL database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureSqlDWTableDataset": { + "x-ms-discriminator-value": "AzureSqlDWTable", + "description": "The Azure SQL Data Warehouse dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSqlDWTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSqlDWTableDatasetTypeProperties": { + "description": "Azure SQL Data Warehouse dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "CassandraTableDataset": { + "x-ms-discriminator-value": "CassandraTable", + "description": "The Cassandra database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Cassandra dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CassandraTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CassandraTableDatasetTypeProperties": { + "description": "Cassandra dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the Cassandra database. Type: string (or Expression with resultType string)." + }, + "keyspace": { + "type": "object", + "description": "The keyspace of the Cassandra database. Type: string (or Expression with resultType string)." + } + } + }, + "CustomDataset": { + "description": "The custom dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Custom dataset properties.", + "x-ms-client-flatten": true, + "type": "object" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDataset": { + "x-ms-discriminator-value": "DocumentDbCollection", + "description": "Microsoft Azure Document Database Collection dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "DocumentDB Collection dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DocumentDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DocumentDbCollectionDatasetTypeProperties": { + "description": "DocumentDB Collection dataset properties.", + "properties": { + "collectionName": { + "type": "object", + "description": "Document Database collection name. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "DynamicsEntityDataset": { + "x-ms-discriminator-value": "DynamicsEntity", + "description": "The Dynamics entity dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics entity dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsEntityDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsEntityDatasetTypeProperties": { + "description": "Dynamics entity dataset properties.", + "properties": { + "entityName": { + "type": "object", + "description": "The logical name of the entity. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreDataset": { + "x-ms-discriminator-value": "AzureDataLakeStoreFile", + "description": "Azure Data Lake Store dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDataLakeStoreDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDataLakeStoreDatasetTypeProperties": { + "description": "Azure Data Lake Store dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the Data Lake Store.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "folderPath" + ] + }, + "FileShareDataset": { + "x-ms-discriminator-value": "FileShare", + "description": "An on-premises file system dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises file system dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FileShareDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FileShareDatasetTypeProperties": { + "description": "On-premises file system dataset properties.", + "properties": { + "folderPath": { + "type": "object", + "description": "The path of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "fileName": { + "type": "object", + "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of the files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "fileFilter": { + "type": "object", + "description": "Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the file system.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "MongoDbCollectionDataset": { + "x-ms-discriminator-value": "MongoDbCollection", + "description": "The MongoDB database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbCollectionDatasetTypeProperties": { + "description": "MongoDB database dataset properties.", + "properties": { + "collectionName": { + "type": "object", + "description": "The table name of the MongoDB database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collectionName" + ] + }, + "ODataResourceDataset": { + "x-ms-discriminator-value": "ODataResource", + "description": "The Open Data Protocol (OData) resource dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "OData dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ODataResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ODataResourceDatasetTypeProperties": { + "description": "OData dataset properties.", + "properties": { + "path": { + "type": "object", + "description": "The OData resource path. Type: string (or Expression with resultType string)." + } + } + }, + "OracleTableDataset": { + "x-ms-discriminator-value": "OracleTable", + "description": "The on-premises Oracle database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises Oracle dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleTableDatasetTypeProperties": { + "description": "On-premises Oracle dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the on-premises Oracle database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "AzureMySqlTableDataset": { + "x-ms-discriminator-value": "AzureMySqlTable", + "description": "The Azure MySQL database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Azure MySQL database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureMySqlTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMySqlTableDatasetTypeProperties": { + "description": "Azure MySQL database dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The Azure MySQL database table name. Type: string (or Expression with resultType string)." + } + } + }, + "RelationalTableDataset": { + "x-ms-discriminator-value": "RelationalTable", + "description": "The relational table dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Relational table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RelationalTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RelationalTableDatasetTypeProperties": { + "description": "Relational table dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The relational table name. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceObjectDataset": { + "x-ms-discriminator-value": "SalesforceObject", + "description": "The Salesforce object dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Salesforce object dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SalesforceObjectDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SalesforceObjectDatasetTypeProperties": { + "description": "Salesforce object dataset properties.", + "properties": { + "objectApiName": { + "type": "object", + "description": "The Salesforce object API name. Type: string (or Expression with resultType string)." + } + } + }, + "SapCloudForCustomerResourceDataset": { + "x-ms-discriminator-value": "SapCloudForCustomerResource", + "description": "The path of the SAP Cloud for Customer OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP Cloud For Customer OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapCloudForCustomerResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapCloudForCustomerResourceDatasetTypeProperties": { + "description": "Sap Cloud For Customer OData resource dataset properties.", + "properties": { + "path": { + "type": "object", + "description": "The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SapEccResourceDataset": { + "x-ms-discriminator-value": "SapEccResource", + "description": "The path of the SAP ECC OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "SAP ECC OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SapEccResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SapEccResourceDatasetTypeProperties": { + "description": "Sap ECC OData resource dataset properties.", + "properties": { + "path": { + "type": "string", + "description": "The path of the SAP ECC OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, + "SqlServerTableDataset": { + "x-ms-discriminator-value": "SqlServerTable", + "description": "The on-premises SQL Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "On-premises SQL Server dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlServerTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SqlServerTableDatasetTypeProperties": { + "description": "On-premises SQL Server dataset properties.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "tableName" + ] + }, + "WebTableDataset": { + "x-ms-discriminator-value": "WebTable", + "description": "The dataset points to a HTML table in the web page.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Web table dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebTableDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebTableDatasetTypeProperties": { + "description": "Web table dataset properties.", + "properties": { + "index": { + "type": "object", + "description": "The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "path": { + "type": "object", + "description": "The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "index" + ] + }, + "AzureSearchIndexDataset": { + "x-ms-discriminator-value": "AzureSearchIndex", + "description": "The Azure Search Index.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureSearchIndexDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureSearchIndexDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "indexName": { + "type": "object", + "description": "The name of the Azure Search Index. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "indexName" + ] + }, + "HttpDataset": { + "x-ms-discriminator-value": "HttpFile", + "description": "A file in an HTTP web server.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HttpDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HttpDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method for the HTTP request. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The body for the HTTP request. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1\r\n...\r\nrequest-header-name-n:request-header-value-n Type: string (or Expression with resultType string)." + }, + "format": { + "description": "The format of files.", + "$ref": "#/definitions/DatasetStorageFormat" + }, + "compression": { + "description": "The data compression method used on files.", + "$ref": "#/definitions/DatasetCompression" + } + } + }, + "AmazonMWSObjectDataset" : { + "x-ms-discriminator-value": "AmazonMWSObject", + "description": "Amazon Marketplace Web Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "AzurePostgreSqlTableDataset" : { + "x-ms-discriminator-value": "AzurePostgreSqlTable", + "description": "Azure PostgreSQL dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ConcurObjectDataset" : { + "x-ms-discriminator-value": "ConcurObject", + "description": "Concur Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "CouchbaseTableDataset" : { + "x-ms-discriminator-value": "CouchbaseTable", + "description": "Couchbase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "DrillTableDataset" : { + "x-ms-discriminator-value": "DrillTable", + "description": "Drill server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "EloquaObjectDataset" : { + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GoogleBigQueryObjectDataset" : { + "x-ms-discriminator-value": "GoogleBigQueryObject", + "description": "Google BigQuery service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GreenplumTableDataset" : { + "x-ms-discriminator-value": "GreenplumTable", + "description": "Greenplum Database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HBaseObjectDataset" : { + "x-ms-discriminator-value": "HBaseObject", + "description": "HBase server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HiveObjectDataset" : { + "x-ms-discriminator-value": "HiveObject", + "description": "Hive Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "HubspotObjectDataset" : { + "x-ms-discriminator-value": "HubspotObject", + "description": "Hubspot Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ImpalaObjectDataset" : { + "x-ms-discriminator-value": "ImpalaObject", + "description": "Impala server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "JiraObjectDataset" : { + "x-ms-discriminator-value": "JiraObject", + "description": "Jira Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MagentoObjectDataset" : { + "x-ms-discriminator-value": "MagentoObject", + "description": "Magento server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MariaDBTableDataset" : { + "x-ms-discriminator-value": "MariaDBTable", + "description": "MariaDB server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "MarketoObjectDataset" : { + "x-ms-discriminator-value": "MarketoObject", + "description": "Marketo server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PaypalObjectDataset" : { + "x-ms-discriminator-value": "PaypalObject", + "description": "Paypal Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PhoenixObjectDataset" : { + "x-ms-discriminator-value": "PhoenixObject", + "description": "Phoenix server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "PrestoObjectDataset" : { + "x-ms-discriminator-value": "PrestoObject", + "description": "Presto server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "QuickBooksObjectDataset" : { + "x-ms-discriminator-value": "QuickBooksObject", + "description": "QuickBooks server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ServiceNowObjectDataset" : { + "x-ms-discriminator-value": "ServiceNowObject", + "description": "ServiceNow server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ShopifyObjectDataset" : { + "x-ms-discriminator-value": "ShopifyObject", + "description": "Shopify Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SparkObjectDataset" : { + "x-ms-discriminator-value": "SparkObject", + "description": "Spark Server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SquareObjectDataset" : { + "x-ms-discriminator-value": "SquareObject", + "description": "Square Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "XeroObjectDataset" : { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Serivce dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ZohoObjectDataset" : { + "x-ms-discriminator-value": "ZohoObject", + "description": "Zoho server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "NetezzaTableDataset" : { + "x-ms-discriminator-value": "NetezzaTable", + "description": "Netezza dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "VerticaTableDataset" : { + "x-ms-discriminator-value": "VerticaTable", + "description": "Vertica dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "SalesforceMarketingCloudObjectDataset": { + "x-ms-discriminator-value": "SalesforceMarketingCloudObject", + "description": "Salesforce Marketing Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "ResponsysObjectDataset": { + "x-ms-discriminator-value": "ResponsysObject", + "description": "Responsys dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json index b3ee8b8e428e..50730d9306fd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json @@ -1,959 +1,959 @@ -{ - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2017-09-01-preview" - }, - "paths": {}, - "definitions": { - "IntegrationRuntime": { - "description": "Azure Data Factory nested object which serves as a compute resource for activities.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "Type of integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeType" - }, - "description": { - "description": "Integration runtime description.", - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "IntegrationRuntimeType": { - "description": "The type of integration runtime.", - "type": "string", - "enum": [ - "Managed", - "SelfHosted" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeType", - "modelAsString": true - } - }, - "ManagedIntegrationRuntime": { - "x-ms-discriminator-value": "Managed", - "description": "Managed integration runtime, including managed elastic and managed dedicated integration runtimes.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IntegrationRuntime" - } - ], - "properties": { - "state": { - "description": "Integration runtime state, only valid for managed dedicated integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeState", - "readOnly": true - }, - "typeProperties": { - "description": "Managed integration runtime properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ManagedIntegrationRuntimeTypeProperties": { - "description": "Managed integration runtime type properties.", - "type": "object", - "properties": { - "computeProperties": { - "description": "The compute resource for managed integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeComputeProperties" - }, - "ssisProperties": { - "description": "SSIS properties for managed integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeSsisProperties" - } - } - }, - "IntegrationRuntimeComputeProperties": { - "description": "The compute resource properties for managed integration runtime.", - "type": "object", - "properties": { - "location": { - "description": "The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities", - "type": "string" - }, - "nodeSize": { - "description": "The node size requirement to managed integration runtime.", - "type": "string" - }, - "numberOfNodes": { - "description": "The required number of nodes for managed integration runtime.", - "type": "integer", - "minimum": 1 - }, - "maxParallelExecutionsPerNode": { - "description": "Maximum parallel executions count per node for managed integration runtime.", - "type": "integer", - "minimum": 1 - }, - "vNetProperties": { - "description": "VNet properties for managed integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeVNetProperties" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeVNetProperties": { - "description": "VNet properties for managed integration runtime.", - "type": "object", - "properties": { - "vNetId": { - "description": "The ID of the VNet that this integration runtime will join.", - "type": "string" - }, - "subnet": { - "description": "The name of the subnet this integration runtime will join.", - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeSsisProperties": { - "description": "SSIS properties for managed integration runtime.", - "type": "object", - "properties": { - "catalogInfo": { - "description": "Catalog information for managed dedicated integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeSsisCatalogInfo" - }, - "licenseType": { - "description": "License type for bringing your own license scenario.", - "type": "string", - "enum": [ - "BasePrice", - "LicenseIncluded" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeLicenseType", - "modelAsString": true - } - }, - "customSetupScriptProperties": { - "description": "Custom setup script properties for a managed dedicated integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeCustomSetupScriptProperties" - }, - "edition": { - "description": "The edition for the SSIS Integration Runtime", - "type": "string", - "enum": [ - "Standard", - "Enterprise" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeEdition", - "modelAsString": true - } - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeSsisCatalogInfo": { - "description": "Catalog information for managed dedicated integration runtime.", - "type": "object", - "properties": { - "catalogServerEndpoint": { - "description": "The catalog database server URL.", - "type": "string" - }, - "catalogAdminUserName": { - "description": "The administrator user name of catalog database.", - "type": "string", - "minLength": 1, - "maxLength": 128 - }, - "catalogAdminPassword": { - "description": "The password of the administrator user account of the catalog database.", - "$ref": "../datafactory.json#/definitions/SecureString" - }, - "catalogPricingTier": { - "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/", - "type": "string", - "enum": [ - "Basic", - "Standard", - "Premium", - "PremiumRS" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeSsisCatalogPricingTier", - "modelAsString": true - } - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeCustomSetupScriptProperties": { - "description": "Custom setup script properties for a managed dedicated integration runtime.", - "type": "object", - "properties": { - "blobContainerUri": { - "description": "The URI of the Azure blob container that contains the custom setup script.", - "type": "string" - }, - "sasToken": { - "description": "The SAS token of the Azure blob container.", - "$ref": "../datafactory.json#/definitions/SecureString" - } - } - }, - "SelfHostedIntegrationRuntime": { - "x-ms-discriminator-value": "SelfHosted", - "description": "Self-hosted integration runtime.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IntegrationRuntime" - } - ], - "properties": { - "typeProperties": { - "description": "When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/LinkedIntegrationRuntimeTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "LinkedIntegrationRuntimeTypeProperties": { - "description": "The base definition of a secret type.", - "type": "object", - "properties": { - "linkedInfo": { - "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" - } - } - }, - "LinkedIntegrationRuntimeProperties": { - "description": "The base definition of a secret type.", - "discriminator": "authorizationType", - "type": "object", - "properties": { - "authorizationType": { - "type": "string", - "description": "Type of the secret." - } - }, - "required": [ - "authorizationType" - ] - }, - "LinkedIntegrationRuntimeKey": { - "x-ms-discriminator-value": "Key", - "description": "The base definition of a secret type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" - } - ], - "properties": { - "key": { - "description": "Type of the secret.", - "$ref": "../datafactory.json#/definitions/SecureString" - } - }, - "required": [ - "key" - ] - }, - "LinkedIntegrationRuntimeRbac": { - "x-ms-discriminator-value": "RBAC", - "description": "The base definition of a secret type.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" - } - ], - "properties": { - "resourceId": { - "description": "The resource ID of the integration runtime to be shared.", - "type": "string" - } - }, - "required": [ - "resourceId" - ] - }, - "IntegrationRuntimeStatus": { - "description": "Integration runtime status.", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "description": "Type of integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeType" - }, - "dataFactoryName": { - "description": "The data factory name which the integration runtime belong to.", - "type": "string", - "readOnly": true - }, - "state": { - "description": "The state of integration runtime.", - "$ref": "#/definitions/IntegrationRuntimeState", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeState": { - "description": "The state of integration runtime.", - "type": "string", - "readOnly": true, - "enum": [ - "Initial", - "Stopped", - "Started", - "Starting", - "Stopping", - "NeedRegistration", - "Online", - "Limited", - "Offline" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeState", - "modelAsString": true - } - }, - "ManagedIntegrationRuntimeStatus": { - "x-ms-discriminator-value": "Managed", - "description": "Managed integration runtime status.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IntegrationRuntimeStatus" - } - ], - "properties": { - "typeProperties": { - "description": "Managed integration runtime status type properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ManagedIntegrationRuntimeStatusTypeProperties": { - "description": "Managed integration runtime status type properties.", - "type": "object", - "properties": { - "createTime": { - "description": "The time at which the integration runtime was created, in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "nodes": { - "description": "The list of nodes for managed integration runtime.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedIntegrationRuntimeNode" - }, - "readOnly": true - }, - "otherErrors": { - "description": "The errors that occurred on this integration runtime.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedIntegrationRuntimeError" - }, - "readOnly": true - }, - "lastOperation": { - "description": "The last operation result that occurred on this integration runtime.", - "$ref": "#/definitions/ManagedIntegrationRuntimeOperationResult", - "readOnly": true - } - } - }, - "ManagedIntegrationRuntimeOperationResult": { - "description": "Properties of managed integration runtime operation result.", - "properties": { - "type": { - "description": "The operation type. Could be start or stop.", - "type": "string", - "readOnly": true - }, - "startTime": { - "description": "The start time of the operation.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "result": { - "description": "The operation result.", - "type": "string", - "readOnly": true - }, - "errorCode": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "parameters": { - "description": "Managed integration runtime error parameters.", - "type": "array", - "items": { - "type": "string", - "description": "Error message parameters." - }, - "readOnly": true - }, - "activityId": { - "description": "The activity id for the operation request.", - "type": "string", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "ManagedIntegrationRuntimeNode": { - "description": "Properties of integration runtime node.", - "properties": { - "nodeId": { - "description": "The managed integration runtime node id.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "The managed integration runtime node status.", - "type": "string", - "readOnly": true, - "enum": [ - "Starting", - "Available", - "Recycling", - "Unavailable" - ], - "x-ms-enum": { - "name": "ManagedIntegrationRuntimeNodeStatus", - "modelAsString": true - } - }, - "errors": { - "description": "The errors that occurred on this integration runtime node.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedIntegrationRuntimeError" - } - } - }, - "additionalProperties": { - "type": "object" - } - }, - "ManagedIntegrationRuntimeError": { - "description": "Error definition for managed integration runtime.", - "properties": { - "time": { - "description": "The time when the error occurred.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "parameters": { - "description": "Managed integration runtime error parameters.", - "type": "array", - "items": { - "type": "string", - "description": "Error message parameters." - }, - "readOnly": true - }, - "message": { - "description": "Error message.", - "type": "string", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "SelfHostedIntegrationRuntimeStatus": { - "x-ms-discriminator-value": "SelfHosted", - "description": "Self-hosted integration runtime status.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/IntegrationRuntimeStatus" - } - ], - "properties": { - "typeProperties": { - "description": "Self-hosted integration runtime status type properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SelfHostedIntegrationRuntimeStatusTypeProperties": { - "description": "Self-hosted integration runtime status type properties.", - "type": "object", - "properties": { - "createTime": { - "description": "The time at which the integration runtime was created, in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "taskQueueId": { - "description": "The task queue id of the integration runtime.", - "type": "string", - "readOnly": true - }, - "internalChannelEncryption": { - "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", - "type": "string", - "readOnly": true, - "enum": [ - "NotSet", - "SslEncrypted", - "NotEncrypted" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeInternalChannelEncryptionMode", - "modelAsString": true - } - }, - "version": { - "description": "Version of the integration runtime.", - "type": "string", - "readOnly": true - }, - "nodes": { - "description": "The list of nodes for this integration runtime.", - "type": "array", - "items": { - "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" - } - }, - "scheduledUpdateDate": { - "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updateDelayOffset": { - "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours", - "type": "string", - "readOnly": true - }, - "localTimeZoneOffset": { - "description": "The local time zone offset in hours.", - "type": "string", - "readOnly": true - }, - "capabilities": { - "description": "Object with additional information about integration runtime capabilities.", - "type": "object", - "readOnly": true, - "additionalProperties": { - "type": "string" - } - }, - "serviceUrls": { - "description": "The URLs for the services used in integration runtime backend service.", - "type": "array", - "items": { - "description": "The service URL", - "type": "string" - }, - "readOnly": true - }, - "autoUpdate": { - "description": "Whether Self-hosted integration runtime auto update has been turned on.", - "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", - "readOnly": true - }, - "versionStatus": { - "description": "Status of the integration runtime version.", - "type": "string", - "readOnly": true - }, - "links": { - "description": "The list of linked integration runtimes that are created to share with this integration runtime.", - "type": "array", - "items": { - "$ref": "#/definitions/LinkedIntegrationRuntime" - } - } - } - }, - "IntegrationRuntimeAutoUpdate": { - "description": "The state of integration runtime auto update.", - "type": "string", - "readOnly": true, - "enum": [ - "On", - "Off" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeAutoUpdate", - "modelAsString": true - } - }, - "LinkedIntegrationRuntime": { - "description": "The linked integration runtime information.", - "type": "object", - "properties": { - "name": { - "description": "The name of the linked integration runtime.", - "type": "string", - "readOnly": true - }, - "subscriptionId": { - "description": "The subscription ID for which the linked integration runtime belong to.", - "type": "string", - "readOnly": true - }, - "dataFactoryName": { - "description": "The name of the data factory for which the linked integration runtime belong to.", - "type": "string", - "readOnly": true - }, - "dataFactoryLocation": { - "description": "The location of the data factory for which the linked integration runtime belong to.", - "type": "string", - "readOnly": true - }, - "createTime": { - "description": "The creating time of the linked integration runtime.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "SelfHostedIntegrationRuntimeNode": { - "description": "Properties of Self-hosted integration runtime node.", - "properties": { - "nodeName": { - "description": "Name of the integration runtime node.", - "type": "string", - "readOnly": true - }, - "machineName": { - "description": "Machine name of the integration runtime node.", - "type": "string", - "readOnly": true - }, - "hostServiceUri": { - "description": "URI for the host machine of the integration runtime.", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of the integration runtime node.", - "type": "string", - "readOnly": true, - "enum": [ - "NeedRegistration", - "Online", - "Limited", - "Offline", - "Upgrading", - "Initializing", - "InitializeFailed" - ], - "x-ms-enum": { - "name": "SelfHostedIntegrationRuntimeNodeStatus", - "modelAsString": true - } - }, - "capabilities": { - "description": "The integration runtime capabilities dictionary", - "type": "object", - "readOnly": true, - "additionalProperties": { - "type": "string" - } - }, - "versionStatus": { - "description": "Status of the integration runtime node version.", - "type": "string", - "readOnly": true - }, - "version": { - "description": "Version of the integration runtime node.", - "type": "string", - "readOnly": true - }, - "registerTime": { - "description": "The time at which the integration runtime node was registered in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "lastConnectTime": { - "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "expiryTime": { - "description": "The time at which the integration runtime will expire in ISO8601 format.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "lastStartTime": { - "description": "The time the node last started up.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "lastStopTime": { - "description": "The integration runtime node last stop time.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "lastUpdateResult": { - "description": "The result of the last integration runtime node update.", - "type": "string", - "enum": [ - "Succeed", - "Fail" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeUpdateResult", - "modelAsString": true - }, - "readOnly": true - }, - "lastStartUpdateTime": { - "description": "The last time for the integration runtime node update start.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "lastEndUpdateTime": { - "description": "The last time for the integration runtime node update end.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "isActiveDispatcher": { - "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", - "type": "boolean", - "readOnly": true - }, - "concurrentJobsLimit": { - "description": "Maximum concurrent jobs on the integration runtime node.", - "type": "integer", - "readOnly": true - }, - "maxConcurrentJobs": { - "description": "The maximum concurrent jobs in this integration runtime.", - "type": "integer", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeRemoveNodeRequest": { - "description": "Request to remove a node.", - "type": "object", - "properties": { - "nodeName": { - "description": "The name of the node to be removed.", - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeConnectionInfo": { - "description": "Connection information for encrypting the on-premises data source credentials.", - "type": "object", - "properties": { - "serviceToken": { - "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", - "type": "string", - "readOnly": true - }, - "identityCertThumbprint": { - "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", - "type": "string", - "readOnly": true - }, - "hostServiceUri": { - "description": "The on-premises integration runtime host URL.", - "type": "string", - "readOnly": true - }, - "version": { - "description": "The integration runtime version.", - "type": "string", - "readOnly": true - }, - "publicKey": { - "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", - "type": "string", - "readOnly": true - }, - "isIdentityCertExprired": { - "description": "Whether the identity certificate is expired.", - "type": "boolean", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeRegenerateKeyParameters": { - "description": "Parameters to regenerate the authentication key.", - "type": "object", - "properties": { - "keyName": { - "description": "The name of the authentication key to regenerate.", - "type": "string", - "enum": [ - "authKey1", - "authKey2" - ], - "x-ms-enum": { - "name": "IntegrationRuntimeAuthKeyName", - "modelAsString": true - } - } - } - }, - "IntegrationRuntimeAuthKeys": { - "description": "The integration runtime authentication keys.", - "type": "object", - "properties": { - "authKey1": { - "type": "string", - "description": "The primary integration runtime authentication key." - }, - "authKey2": { - "type": "string", - "description": "The secondary integration runtime authentication key." - } - } - }, - "IntegrationRuntimeMonitoringData": { - "description": "Get monitoring data response.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Integration runtime name." - }, - "nodes": { - "type": "array", - "description": "Integration runtime node monitoring data.", - "items": { - "$ref": "#/definitions/IntegrationRuntimeNodeMonitoringData" - } - } - } - }, - "IntegrationRuntimeNodeMonitoringData": { - "description": "Monitoring data for integration runtime node.", - "type": "object", - "properties": { - "nodeName": { - "description": "Name of the integration runtime node.", - "type": "string", - "readOnly": true - }, - "availableMemoryInMB": { - "description": "Available memory (MB) on the integration runtime node.", - "type": "integer", - "readOnly": true - }, - "cpuUtilization": { - "description": "CPU percentage on the integration runtime node.", - "type": "number", - "readOnly": true - }, - "concurrentJobsLimit": { - "description": "Maximum concurrent jobs on the integration runtime node.", - "type": "integer", - "readOnly": true - }, - "concurrentJobsRunning": { - "description": "The number of jobs currently running on the integration runtime node.", - "type": "integer", - "readOnly": true - }, - "maxConcurrentJobs": { - "description": "The maximum concurrent jobs in this integration runtime.", - "type": "integer", - "readOnly": true - }, - "sentBytes": { - "description": "Sent bytes on the integration runtime node.", - "type": "number", - "readOnly": true - }, - "receivedBytes": { - "description": "Received bytes on the integration runtime node.", - "type": "number", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - } - }, - "IntegrationRuntimeNodeIpAddress": { - "type": "object", - "description": "The IP address of self-hosted integration runtime node.", - "properties": { - "ipAddress": { - "description": "The IP address of self-hosted integration runtime node.", - "type": "string", - "readOnly": true - } - } - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "IntegrationRuntime": { + "description": "Azure Data Factory nested object which serves as a compute resource for activities.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "description": { + "description": "Integration runtime description.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "IntegrationRuntimeType": { + "description": "The type of integration runtime.", + "type": "string", + "enum": [ + "Managed", + "SelfHosted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeType", + "modelAsString": true + } + }, + "ManagedIntegrationRuntime": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime, including managed elastic and managed dedicated integration runtimes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "state": { + "description": "Integration runtime state, only valid for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + }, + "typeProperties": { + "description": "Managed integration runtime properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeTypeProperties": { + "description": "Managed integration runtime type properties.", + "type": "object", + "properties": { + "computeProperties": { + "description": "The compute resource for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeComputeProperties" + }, + "ssisProperties": { + "description": "SSIS properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisProperties" + } + } + }, + "IntegrationRuntimeComputeProperties": { + "description": "The compute resource properties for managed integration runtime.", + "type": "object", + "properties": { + "location": { + "description": "The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities", + "type": "string" + }, + "nodeSize": { + "description": "The node size requirement to managed integration runtime.", + "type": "string" + }, + "numberOfNodes": { + "description": "The required number of nodes for managed integration runtime.", + "type": "integer", + "minimum": 1 + }, + "maxParallelExecutionsPerNode": { + "description": "Maximum parallel executions count per node for managed integration runtime.", + "type": "integer", + "minimum": 1 + }, + "vNetProperties": { + "description": "VNet properties for managed integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeVNetProperties" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeVNetProperties": { + "description": "VNet properties for managed integration runtime.", + "type": "object", + "properties": { + "vNetId": { + "description": "The ID of the VNet that this integration runtime will join.", + "type": "string" + }, + "subnet": { + "description": "The name of the subnet this integration runtime will join.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeSsisProperties": { + "description": "SSIS properties for managed integration runtime.", + "type": "object", + "properties": { + "catalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeSsisCatalogInfo" + }, + "licenseType": { + "description": "License type for bringing your own license scenario.", + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeLicenseType", + "modelAsString": true + } + }, + "customSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeCustomSetupScriptProperties" + }, + "edition": { + "description": "The edition for the SSIS Integration Runtime", + "type": "string", + "enum": [ + "Standard", + "Enterprise" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeEdition", + "modelAsString": true + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeSsisCatalogInfo": { + "description": "Catalog information for managed dedicated integration runtime.", + "type": "object", + "properties": { + "catalogServerEndpoint": { + "description": "The catalog database server URL.", + "type": "string" + }, + "catalogAdminUserName": { + "description": "The administrator user name of catalog database.", + "type": "string", + "minLength": 1, + "maxLength": 128 + }, + "catalogAdminPassword": { + "description": "The password of the administrator user account of the catalog database.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "catalogPricingTier": { + "description": "The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Premium", + "PremiumRS" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeSsisCatalogPricingTier", + "modelAsString": true + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeCustomSetupScriptProperties": { + "description": "Custom setup script properties for a managed dedicated integration runtime.", + "type": "object", + "properties": { + "blobContainerUri": { + "description": "The URI of the Azure blob container that contains the custom setup script.", + "type": "string" + }, + "sasToken": { + "description": "The SAS token of the Azure blob container.", + "$ref": "../datafactory.json#/definitions/SecureString" + } + } + }, + "SelfHostedIntegrationRuntime": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntime" + } + ], + "properties": { + "typeProperties": { + "description": "When this property is not null, means this is a linked integration runtime. The property is used to access original integration runtime.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LinkedIntegrationRuntimeTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LinkedIntegrationRuntimeTypeProperties": { + "description": "The base definition of a secret type.", + "type": "object", + "properties": { + "linkedInfo": { + "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" + } + } + }, + "LinkedIntegrationRuntimeProperties": { + "description": "The base definition of a secret type.", + "discriminator": "authorizationType", + "type": "object", + "properties": { + "authorizationType": { + "type": "string", + "description": "Type of the secret." + } + }, + "required": [ + "authorizationType" + ] + }, + "LinkedIntegrationRuntimeKey": { + "x-ms-discriminator-value": "Key", + "description": "The base definition of a secret type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" + } + ], + "properties": { + "key": { + "description": "Type of the secret.", + "$ref": "../datafactory.json#/definitions/SecureString" + } + }, + "required": [ + "key" + ] + }, + "LinkedIntegrationRuntimeRbac": { + "x-ms-discriminator-value": "RBAC", + "description": "The base definition of a secret type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedIntegrationRuntimeProperties" + } + ], + "properties": { + "resourceId": { + "description": "The resource ID of the integration runtime to be shared.", + "type": "string" + } + }, + "required": [ + "resourceId" + ] + }, + "IntegrationRuntimeStatus": { + "description": "Integration runtime status.", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeType" + }, + "dataFactoryName": { + "description": "The data factory name which the integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The state of integration runtime.", + "$ref": "#/definitions/IntegrationRuntimeState", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeState": { + "description": "The state of integration runtime.", + "type": "string", + "readOnly": true, + "enum": [ + "Initial", + "Stopped", + "Started", + "Starting", + "Stopping", + "NeedRegistration", + "Online", + "Limited", + "Offline" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeState", + "modelAsString": true + } + }, + "ManagedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "Managed", + "description": "Managed integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Managed integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ManagedIntegrationRuntimeStatusTypeProperties": { + "description": "Managed integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for managed integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeNode" + }, + "readOnly": true + }, + "otherErrors": { + "description": "The errors that occurred on this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + }, + "readOnly": true + }, + "lastOperation": { + "description": "The last operation result that occurred on this integration runtime.", + "$ref": "#/definitions/ManagedIntegrationRuntimeOperationResult", + "readOnly": true + } + } + }, + "ManagedIntegrationRuntimeOperationResult": { + "description": "Properties of managed integration runtime operation result.", + "properties": { + "type": { + "description": "The operation type. Could be start or stop.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "result": { + "description": "The operation result.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "activityId": { + "description": "The activity id for the operation request.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeNode": { + "description": "Properties of integration runtime node.", + "properties": { + "nodeId": { + "description": "The managed integration runtime node id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The managed integration runtime node status.", + "type": "string", + "readOnly": true, + "enum": [ + "Starting", + "Available", + "Recycling", + "Unavailable" + ], + "x-ms-enum": { + "name": "ManagedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "errors": { + "description": "The errors that occurred on this integration runtime node.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedIntegrationRuntimeError" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "ManagedIntegrationRuntimeError": { + "description": "Error definition for managed integration runtime.", + "properties": { + "time": { + "description": "The time when the error occurred.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "Managed integration runtime error parameters.", + "type": "array", + "items": { + "type": "string", + "description": "Error message parameters." + }, + "readOnly": true + }, + "message": { + "description": "Error message.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "SelfHostedIntegrationRuntimeStatus": { + "x-ms-discriminator-value": "SelfHosted", + "description": "Self-hosted integration runtime status.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IntegrationRuntimeStatus" + } + ], + "properties": { + "typeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SelfHostedIntegrationRuntimeStatusTypeProperties": { + "description": "Self-hosted integration runtime status type properties.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the integration runtime was created, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "taskQueueId": { + "description": "The task queue id of the integration runtime.", + "type": "string", + "readOnly": true + }, + "internalChannelEncryption": { + "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", + "type": "string", + "readOnly": true, + "enum": [ + "NotSet", + "SslEncrypted", + "NotEncrypted" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeInternalChannelEncryptionMode", + "modelAsString": true + } + }, + "version": { + "description": "Version of the integration runtime.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "The list of nodes for this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" + } + }, + "scheduledUpdateDate": { + "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updateDelayOffset": { + "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours", + "type": "string", + "readOnly": true + }, + "localTimeZoneOffset": { + "description": "The local time zone offset in hours.", + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "Object with additional information about integration runtime capabilities.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "serviceUrls": { + "description": "The URLs for the services used in integration runtime backend service.", + "type": "array", + "items": { + "description": "The service URL", + "type": "string" + }, + "readOnly": true + }, + "autoUpdate": { + "description": "Whether Self-hosted integration runtime auto update has been turned on.", + "$ref": "#/definitions/IntegrationRuntimeAutoUpdate", + "readOnly": true + }, + "versionStatus": { + "description": "Status of the integration runtime version.", + "type": "string", + "readOnly": true + }, + "links": { + "description": "The list of linked integration runtimes that are created to share with this integration runtime.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedIntegrationRuntime" + } + } + } + }, + "IntegrationRuntimeAutoUpdate": { + "description": "The state of integration runtime auto update.", + "type": "string", + "readOnly": true, + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAutoUpdate", + "modelAsString": true + } + }, + "LinkedIntegrationRuntime": { + "description": "The linked integration runtime information.", + "type": "object", + "properties": { + "name": { + "description": "The name of the linked integration runtime.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The subscription ID for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryName": { + "description": "The name of the data factory for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "dataFactoryLocation": { + "description": "The location of the data factory for which the linked integration runtime belong to.", + "type": "string", + "readOnly": true + }, + "createTime": { + "description": "The creating time of the linked integration runtime.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "SelfHostedIntegrationRuntimeNode": { + "description": "Properties of Self-hosted integration runtime node.", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "machineName": { + "description": "Machine name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "URI for the host machine of the integration runtime.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the integration runtime node.", + "type": "string", + "readOnly": true, + "enum": [ + "NeedRegistration", + "Online", + "Limited", + "Offline", + "Upgrading", + "Initializing", + "InitializeFailed" + ], + "x-ms-enum": { + "name": "SelfHostedIntegrationRuntimeNodeStatus", + "modelAsString": true + } + }, + "capabilities": { + "description": "The integration runtime capabilities dictionary", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "string" + } + }, + "versionStatus": { + "description": "Status of the integration runtime node version.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Version of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "registerTime": { + "description": "The time at which the integration runtime node was registered in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastConnectTime": { + "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "expiryTime": { + "description": "The time at which the integration runtime will expire in ISO8601 format.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStartTime": { + "description": "The time the node last started up.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastStopTime": { + "description": "The integration runtime node last stop time.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastUpdateResult": { + "description": "The result of the last integration runtime node update.", + "type": "string", + "enum": [ + "Succeed", + "Fail" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeUpdateResult", + "modelAsString": true + }, + "readOnly": true + }, + "lastStartUpdateTime": { + "description": "The last time for the integration runtime node update start.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastEndUpdateTime": { + "description": "The last time for the integration runtime node update end.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "isActiveDispatcher": { + "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", + "type": "boolean", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeRemoveNodeRequest": { + "description": "Request to remove a node.", + "type": "object", + "properties": { + "nodeName": { + "description": "The name of the node to be removed.", + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeConnectionInfo": { + "description": "Connection information for encrypting the on-premises data source credentials.", + "type": "object", + "properties": { + "serviceToken": { + "description": "The token generated in service. Callers use this token to authenticate to integration runtime.", + "type": "string", + "readOnly": true + }, + "identityCertThumbprint": { + "description": "The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.", + "type": "string", + "readOnly": true + }, + "hostServiceUri": { + "description": "The on-premises integration runtime host URL.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The integration runtime version.", + "type": "string", + "readOnly": true + }, + "publicKey": { + "description": "The public key for encrypting a credential when transferring the credential to the integration runtime.", + "type": "string", + "readOnly": true + }, + "isIdentityCertExprired": { + "description": "Whether the identity certificate is expired.", + "type": "boolean", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeRegenerateKeyParameters": { + "description": "Parameters to regenerate the authentication key.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the authentication key to regenerate.", + "type": "string", + "enum": [ + "authKey1", + "authKey2" + ], + "x-ms-enum": { + "name": "IntegrationRuntimeAuthKeyName", + "modelAsString": true + } + } + } + }, + "IntegrationRuntimeAuthKeys": { + "description": "The integration runtime authentication keys.", + "type": "object", + "properties": { + "authKey1": { + "type": "string", + "description": "The primary integration runtime authentication key." + }, + "authKey2": { + "type": "string", + "description": "The secondary integration runtime authentication key." + } + } + }, + "IntegrationRuntimeMonitoringData": { + "description": "Get monitoring data response.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Integration runtime name." + }, + "nodes": { + "type": "array", + "description": "Integration runtime node monitoring data.", + "items": { + "$ref": "#/definitions/IntegrationRuntimeNodeMonitoringData" + } + } + } + }, + "IntegrationRuntimeNodeMonitoringData": { + "description": "Monitoring data for integration runtime node.", + "type": "object", + "properties": { + "nodeName": { + "description": "Name of the integration runtime node.", + "type": "string", + "readOnly": true + }, + "availableMemoryInMB": { + "description": "Available memory (MB) on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "cpuUtilization": { + "description": "CPU percentage on the integration runtime node.", + "type": "number", + "readOnly": true + }, + "concurrentJobsLimit": { + "description": "Maximum concurrent jobs on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "concurrentJobsRunning": { + "description": "The number of jobs currently running on the integration runtime node.", + "type": "integer", + "readOnly": true + }, + "maxConcurrentJobs": { + "description": "The maximum concurrent jobs in this integration runtime.", + "type": "integer", + "readOnly": true + }, + "sentBytes": { + "description": "Sent bytes on the integration runtime node.", + "type": "number", + "readOnly": true + }, + "receivedBytes": { + "description": "Received bytes on the integration runtime node.", + "type": "number", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + } + }, + "IntegrationRuntimeNodeIpAddress": { + "type": "object", + "description": "The IP address of self-hosted integration runtime node.", + "properties": { + "ipAddress": { + "description": "The IP address of self-hosted integration runtime node.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json index 06cda743b02b..7b8f9d752dd4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json @@ -1,2878 +1,2878 @@ -{ - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2017-09-01-preview" - }, - "paths": {}, - "definitions": { - "Pipeline": { - "description": "A data factory pipeline.", - "type": "object", - "properties": { - "description": { - "description": "The description of the pipeline.", - "type": "string" - }, - "activities": { - "type": "array", - "description": "List of activities in pipeline.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", - "description": "List of parameters for pipeline." - }, - "concurrency": { - "type": "integer", - "minimum": 1, - "description": "The max number of concurrent runs for the pipeline." - }, - "annotations": { - "description": "List of tags that can be used for describing the Pipeline.", - "type": "array", - "items": { - "type": "object" - } - } - } - }, - "Activity": { - "discriminator": "type", - "description": "A pipeline activity.", - "type": "object", - "properties": { - "name": { - "description": "Activity name.", - "type": "string" - }, - "type": { - "type": "string", - "description": "Type of activity." - }, - "description": { - "description": "Activity description.", - "type": "string" - }, - "dependsOn": { - "type": "array", - "description": "Activity depends on condition.", - "items": { - "$ref": "#/definitions/ActivityDependency" - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "name", - "type" - ] - }, - "ActivityDependency": { - "description": "Activity dependency information.", - "type": "object", - "properties": { - "activity": { - "description": "Activity name.", - "type": "string" - }, - "dependencyConditions": { - "type": "array", - "description": "Match-Condition for the dependency.", - "items": { - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Skipped", - "Completed" - ], - "x-ms-enum": { - "name": "DependencyCondition", - "modelAsString": true - } - } - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "activity", - "dependencyConditions" - ] - }, - "ControlActivity": { - "x-ms-discriminator-value": "Container", - "description": "Base class for all control activities like IfCondition, ForEach , Until.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": {} - }, - "ExecutionActivity": { - "x-ms-discriminator-value": "Execution", - "description": "Base class for all execution activities.", - "allOf": [ - { - "$ref": "#/definitions/Activity" - } - ], - "properties": { - "linkedServiceName": { - "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "policy": { - "$ref": "#/definitions/ActivityPolicy", - "description": "Activity policy." - } - } - }, - "ActivityPolicy": { - "description": "Execution policy for an activity.", - "type": "object", - "properties": { - "timeout": { - "type": "object", - "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "retry": { - "type": "object", - "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "retryIntervalInSeconds": { - "type": "integer", - "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", - "minimum": 30, - "maximum": 86400 - }, - "secureOutput": { - "type": "boolean", - "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "CopyActivity": { - "x-ms-discriminator-value": "Copy", - "description": "Copy activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Copy activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/CopyActivityTypeProperties" - }, - "inputs": { - "type": "array", - "description": "List of inputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "outputs": { - "type": "array", - "description": "List of outputs for the activity.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - }, - "required": [ - "typeProperties" - ] - }, - "CopyActivityTypeProperties": { - "description": "Copy activity properties.", - "properties": { - "source": { - "description": "Copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "sink": { - "description": "Copy activity sink.", - "$ref": "#/definitions/CopySink" - }, - "translator": { - "description": "Copy activity translator. If not specificed, tabular translator is used.", - "$ref": "#/definitions/CopyTranslator" - }, - "enableStaging": { - "type": "object", - "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "stagingSettings": { - "description": "Specifies interim staging settings when EnableStaging is true.", - "$ref": "#/definitions/StagingSettings" - }, - "parallelCopies": { - "type": "object", - "description": "Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "cloudDataMovementUnits": { - "type": "object", - "description": "Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "enableSkipIncompatibleRow": { - "type": "object", - "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." - }, - "redirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", - "$ref": "#/definitions/RedirectIncompatibleRowSettings" - } - }, - "required": [ - "source", - "sink" - ] - }, - "CopySource": { - "discriminator": "type", - "description": "A copy activity source.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy source type." - }, - "sourceRetryCount": { - "type": "object", - "description": "Source retry count. Type: integer (or Expression with resultType integer)." - }, - "sourceRetryWait": { - "type": "object", - "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "AzureTableSource": { - "description": "A copy activity Azure Table source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "azureTableSourceQuery": { - "type": "object", - "description": "Azure Table source query. Type: string (or Expression with resultType string)." - }, - "azureTableSourceIgnoreTableNotFound": { - "type": "object", - "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "BlobSource": { - "description": "A copy activity Azure Blob source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "treatEmptyAsNull": { - "type": "object", - "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." - }, - "skipHeaderLineCount": { - "type": "object", - "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." - }, - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "DocumentDbCollectionSource": { - "description": "A copy activity Document Database Collection source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Documents query. Type: string (or Expression with resultType string)." - }, - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsSource": { - "description": "A copy activity Dynamics source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." - } - } - }, - "RelationalSource": { - "description": "A copy activity source for various relational databases.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceSource": { - "description": "A copy activity Salesforce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "readBehavior": { - "description": "The read behavior for the operation. Default is Query.", - "type": "string", - "enum": [ - "Query", - "QueryAll" - ], - "x-ms-enum": { - "name": "SalesforceSourceReadBehavior", - "modelAsString": true - } - } - } - }, - "SapCloudForCustomerSource": { - "description": "A copy activity source for SAP Cloud for Customer source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - } - } - }, - "SapEccSource": { - "description": "A copy activity source for SAP ECC source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "string", - "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." - } - } - }, - "SqlSource": { - "description": "A copy activity SQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - } - }, - "SqlDWSource": { - "description": "A copy activity SQL Data Warehouse source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "sqlReaderQuery": { - "type": "object", - "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." - }, - "sqlReaderStoredProcedureName": { - "type": "object", - "description": "Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "type": "object", - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." - } - } - }, - "FileSystemSource": { - "description": "A copy activity file system source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "HdfsSource": { - "description": "A copy activity HDFS source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - }, - "distcpSettings": { - "description": "Specifies Distcp-related settings.", - "$ref": "#/definitions/DistcpSettings" - } - } - }, - "DistcpSettings": { - "description": "Distcp settings.", - "type": "object", - "properties": { - "resourceManagerEndpoint": { - "type": "object", - "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." - }, - "tempScriptPath": { - "type": "object", - "description": "Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string)." - }, - "distcpOptions": { - "type": "object", - "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "resourceManagerEndpoint", - "tempScriptPath" - ] - }, - "AzureMySqlSource": { - "description": "A copy activity Azure MySQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - } - } - }, - "OracleSource": { - "description": "A copy activity Oracle source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "oracleReaderQuery": { - "type": "object", - "description": "Oracle reader query. Type: string (or Expression with resultType string)." - }, - "queryTimeout": { - "type": "object", - "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "WebSource": { - "description": "A copy activity source for web page table.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": {} - }, - "CassandraSource": { - "description": "A copy activity source for a Cassandra database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." - }, - "consistencyLevel": { - "description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.", - "type": "string", - "enum": [ - "ALL", - "EACH_QUORUM", - "QUORUM", - "LOCAL_QUORUM", - "ONE", - "TWO", - "THREE", - "LOCAL_ONE", - "SERIAL", - "LOCAL_SERIAL" - ], - "x-ms-enum": { - "name": "CassandraSourceReadConsistencyLevels", - "modelAsString": true - } - } - } - }, - "MongoDbSource": { - "description": "A copy activity source for a MongoDB database.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreSource": { - "description": "A copy activity Azure Data Lake source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "recursive": { - "type": "object", - "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "HttpSource": { - "description": "A copy activity source for an HTTP file.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "httpRequestTimeout": { - "type": "object", - "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, - "AmazonMWSSource": { - "description": "A copy activity Amazon Marketplace Web Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSource": { - "description": "A copy activity Azure PostgreSQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ConcurSource": { - "description": "A copy activity Concur Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "CouchbaseSource": { - "description": "A copy activity Couchbase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DrillSource": { - "description": "A copy activity Drill server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleBigQuerySource": { - "description": "A copy activity Google BigQuery service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GreenplumSource": { - "description": "A copy activity Greenplum Database source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HBaseSource": { - "description": "A copy activity HBase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HiveSource": { - "description": "A copy activity Hive Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HubspotSource": { - "description": "A copy activity Hubspot Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ImpalaSource": { - "description": "A copy activity Impala server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "JiraSource": { - "description": "A copy activity Jira Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MagentoSource": { - "description": "A copy activity Magento server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MariaDBSource": { - "description": "A copy activity MariaDB server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MarketoSource": { - "description": "A copy activity Marketo server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PaypalSource": { - "description": "A copy activity Paypal Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PhoenixSource": { - "description": "A copy activity Phoenix server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PrestoSource": { - "description": "A copy activity Presto server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "QuickBooksSource": { - "description": "A copy activity QuickBooks server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ServiceNowSource": { - "description": "A copy activity ServiceNow server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ShopifySource": { - "description": "A copy activity Shopify Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SparkSource": { - "description": "A copy activity Spark Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SquareSource": { - "description": "A copy activity Square Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "XeroSource": { - "description": "A copy activity Xero Serivce source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ZohoSource": { - "description": "A copy activity Zoho server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "NetezzaSource": { - "description": "A copy activity Netezza source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "VerticaSource": { - "description": "A copy activity Vertica source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceMarketingCloudSource": { - "description": "A copy activity Salesforce Marketing Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ResponsysSource": { - "description": "A copy activity Responsys source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - } , - "AmazonRedshiftSource": { - "description": "A copy activity source for Amazon Redshift Source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "Database query. Type: string (or Expression with resultType string)." - }, - "redshiftUnloadSettings": { - "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", - "$ref": "#/definitions/RedshiftUnloadSettings" - } - } - }, - "RedshiftUnloadSettings": { - "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", - "type": "object", - "properties": { - "s3LinkedServiceName": { - "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "bucketName": { - "type": "object", - "description": "The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "s3LinkedServiceName", - "bucketName" - ] - }, - "StoredProcedureParameter": { - "description": "SQL stored procedure parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." - }, - "type": { - "description": "Stored procedure parameter type.", - "$ref": "#/definitions/StoredProcedureParameterType" - } - }, - "required": [ - "value" - ] - }, - "StoredProcedureParameterType": { - "description": "Stored procedure parameter type.", - "type": "string", - "enum": [ - "String", - "Int", - "Decimal", - "Guid", - "Boolean", - "Date" - ], - "x-ms-enum": { - "name": "StoredProcedureParameterType", - "modelAsString": true - } - }, - "CopySink": { - "discriminator": "type", - "description": "A copy activity sink.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy sink type." - }, - "writeBatchSize": { - "type": "object", - "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "writeBatchTimeout": { - "type": "object", - "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "sinkRetryCount": { - "type": "object", - "description": "Sink retry count. Type: integer (or Expression with resultType integer)." - }, - "sinkRetryWait": { - "type": "object", - "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "SapCloudForCustomerSink": { - "description": "A copy activity SAP Cloud for Customer sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is 'Insert'.", - "type": "string", - "enum": [ - "Insert", - "Update" - ], - "x-ms-enum": { - "name": "SapCloudForCustomerSinkWriteBehavior", - "modelAsString": true - } - } - } - }, - "AzureQueueSink": { - "description": "A copy activity Azure Queue sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": {} - }, - "CopyBehaviorType": { - "description": "All available types of copy behavior.", - "type": "string", - "enum": [ - "PreserveHierarchy", - "FlattenHierarchy", - "MergeFiles" - ], - "x-ms-enum": { - "name": "CopyBehaviorType", - "modelAsString": true - } - }, - "AzureTableSink": { - "description": "A copy activity Azure Table sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "azureTableDefaultPartitionKeyValue": { - "type": "object", - "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." - }, - "azureTablePartitionKeyName": { - "type": "object", - "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." - }, - "azureTableRowKeyName": { - "type": "object", - "description": "Azure Table row key name. Type: string (or Expression with resultType string)." - }, - "azureTableInsertType": { - "type": "object", - "description": "Azure Table insert type. Type: string (or Expression with resultType string)." - } - } - }, - "BlobSink": { - "description": "A copy activity Azure Blob sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "blobWriterOverwriteFiles": { - "type": "object", - "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." - }, - "blobWriterDateTimeFormat": { - "type": "object", - "description": "Blob writer date time format. Type: string (or Expression with resultType string)." - }, - "blobWriterAddHeader": { - "type": "object", - "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." - }, - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "$ref": "#/definitions/CopyBehaviorType" - } - } - }, - "FileSystemSink": { - "description": "A copy activity file system sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "$ref": "#/definitions/CopyBehaviorType" - } - } - }, - "DocumentDbCollectionSink": { - "description": "A copy activity Document Database Collection sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "nestingSeparator": { - "type": "object", - "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." - } - } - }, - "SqlSink": { - "description": "A copy activity SQL sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "sqlWriterStoredProcedureName": { - "type": "object", - "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." - }, - "sqlWriterTableType": { - "type": "object", - "description": "SQL writer table type. Type: string (or Expression with resultType string)." - }, - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "SQL stored procedure parameters.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - } - }, - "SqlDWSink": { - "description": "A copy activity SQL Data Warehouse sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - }, - "allowPolyBase": { - "type": "object", - "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." - }, - "polyBaseSettings": { - "description": "Specifies PolyBase-related settings when allowPolyBase is true.", - "$ref": "#/definitions/PolybaseSettings" - } - } - }, - "PolybaseSettings": { - "description": "PolyBase settings.", - "type": "object", - "properties": { - "rejectType": { - "$ref": "#/definitions/PolybaseSettingsRejectType", - "description": "Reject type." - }, - "rejectValue": { - "type": "object", - "description": "Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0." - }, - "rejectSampleValue": { - "type": "object", - "description": "Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "useTypeDefault": { - "type": "object", - "description": "Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean)." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "PolybaseSettingsRejectType": { - "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", - "type": "string", - "enum": [ - "value", - "percentage" - ], - "x-ms-enum": { - "name": "PolybaseSettingsRejectType", - "modelAsString": true - } - }, - "StagingSettings": { - "description": "Staging settings.", - "type": "object", - "properties": { - "linkedServiceName": { - "description": "Staging linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "path": { - "type": "object", - "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." - }, - "enableCompression": { - "type": "object", - "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "RedirectIncompatibleRowSettings": { - "description": "Redirect incompatible row settings", - "type": "object", - "properties": { - "linkedServiceName": { - "type": "object", - "description": "Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string)." - }, - "path": { - "type": "object", - "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "linkedServiceName" - ] - }, - "OracleSink": { - "description": "A copy activity Oracle sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." - } - } - }, - "AzureDataLakeStoreSink": { - "description": "A copy activity Azure Data Lake Store sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "copyBehavior": { - "description": "The type of copy behavior for copy sink.", - "$ref": "#/definitions/CopyBehaviorType" - } - } - }, - "AzureSearchIndexSink": { - "description": "A copy activity Azure Search Index sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "Specify the write behavior when upserting documents into Azure Search Index.", - "type": "string", - "enum": [ - "Merge", - "Upload" - ], - "x-ms-enum": { - "name": "AzureSearchIndexWriteBehaviorType", - "modelAsString": true - } - } - } - }, - "OdbcSink": { - "description": "A copy activity ODBC sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "preCopyScript": { - "type": "object", - "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." - } - } - }, - "DynamicsSink": { - "description": "A copy activity Dynamics sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "writeBehavior" - ] - }, - "SalesforceSink": { - "description": "A copy activity Salesforce sink.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySink" - } - ], - "properties": { - "writeBehavior": { - "description": "The write behavior for the operation. Default is Insert.", - "type": "string", - "enum": [ - "Insert", - "Upsert" - ], - "x-ms-enum": { - "name": "SalesforceSinkWriteBehavior", - "modelAsString": true - } - }, - "externalIdFieldName": { - "type": "object", - "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." - }, - "ignoreNullValues": { - "type": "object", - "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." - } - } - }, - "CopyTranslator": { - "discriminator": "type", - "description": "A copy activity translator.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Copy translator type." - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "TabularTranslator": { - "description": "A copy activity tabular translator.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopyTranslator" - } - ], - "properties": { - "columnMappings": { - "type": "object", - "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string)." - }, - "schemaMapping": { - "type": "object", - "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object)." - } - } - }, - "HDInsightHiveActivity": { - "description": "HDInsight Hive activity type.", - "x-ms-discriminator-value": "HDInsightHive", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Hive activity properties.", - "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightHiveActivityTypeProperties": { - "description": "HDInsight Hive activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Hive job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - } - }, - "HDInsightActivityDebugInfoOption": { - "description": "The HDInsightActivityDebugInfoOption settings to use.", - "type": "string", - "enum": [ - "None", - "Always", - "Failure" - ], - "x-ms-enum": { - "name": "HDInsightActivityDebugInfoOption", - "modelAsString": true - } - }, - "HDInsightPigActivity": { - "description": "HDInsight Pig activity type.", - "x-ms-discriminator-value": "HDInsightPig", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight Pig activity properties.", - "$ref": "#/definitions/HDInsightPigActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightPigActivityTypeProperties": { - "description": "HDInsight Pig activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "scriptPath": { - "type": "object", - "description": "Script path. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "defines": { - "description": "Allows user to specify defines for Pig job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - } - }, - "HDInsightMapReduceActivity": { - "description": "HDInsight MapReduce activity type.", - "x-ms-discriminator-value": "HDInsightMapReduce", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight MapReduce activity properties.", - "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightMapReduceActivityTypeProperties": { - "description": "HDInsight MapReduce activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "className": { - "type": "object", - "description": "Class name. Type: string (or Expression with resultType string)." - }, - "jarFilePath": { - "type": "object", - "description": "Jar path. Type: string (or Expression with resultType string)." - }, - "jarLinkedService": { - "description": "Jar linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "jarLibs": { - "description": "Jar libs.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for the MapReduce job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "className", - "jarFilePath" - ] - }, - "HDInsightStreamingActivity": { - "description": "HDInsight streaming activity type.", - "x-ms-discriminator-value": "HDInsightStreaming", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight streaming activity properties.", - "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightStreamingActivityTypeProperties": { - "description": "HDInsight streaming activity properties.", - "properties": { - "storageLinkedServices": { - "description": "Storage linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "arguments": { - "description": "User specified arguments to HDInsightActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "mapper": { - "type": "object", - "description": "Mapper executable name. Type: string (or Expression with resultType string)." - }, - "reducer": { - "type": "object", - "description": "Reducer executable name. Type: string (or Expression with resultType string)." - }, - "input": { - "type": "object", - "description": "Input blob path. Type: string (or Expression with resultType string)." - }, - "output": { - "type": "object", - "description": "Output blob path. Type: string (or Expression with resultType string)." - }, - "filePaths": { - "description": "Paths to streaming job files. Can be directories.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "fileLinkedService": { - "description": "Linked service reference where the files are located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "combiner": { - "type": "object", - "description": "Combiner executable name. Type: string (or Expression with resultType string)." - }, - "commandEnvironment": { - "description": "Command line environment values.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "defines": { - "description": "Allows user to specify defines for streaming job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "mapper", - "reducer", - "input", - "output", - "filePaths" - ] - }, - "HDInsightSparkActivity": { - "description": "HDInsight Spark activity.", - "x-ms-discriminator-value": "HDInsightSpark", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "HDInsight spark activity properties.", - "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HDInsightSparkActivityTypeProperties": { - "description": "HDInsight spark activity properties.", - "properties": { - "rootPath": { - "type": "object", - "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." - }, - "entryFilePath": { - "type": "object", - "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." - }, - "arguments": { - "description": "The user-specified arguments to HDInsightSparkActivity.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "getDebugInfo": { - "$ref": "#/definitions/HDInsightActivityDebugInfoOption", - "description": "Debug info option." - }, - "sparkJobLinkedService": { - "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "className": { - "description": "The application's Java/Spark main class.", - "type": "string" - }, - "proxyUser": { - "type": "object", - "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." - }, - "sparkConfig": { - "description": "Spark configuration property.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "rootPath", - "entryFilePath" - ] - }, - "ExecuteSSISPackageActivity": { - "description": "Execute SSIS package activity.", - "x-ms-discriminator-value": "ExecuteSSISPackage", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Execute SSIS package activity properties.", - "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecuteSSISPackageActivityTypeProperties": { - "description": "Execute SSIS package activity properties.", - "properties": { - "packageLocation": { - "description": "SSIS package location.", - "$ref": "#/definitions/SSISPackageLocation" - }, - "runtime": { - "description": "Specifies the runtime to execute SSIS package.", - "type": "string", - "enum": [ - "x64", - "x86" - ], - "x-ms-enum": { - "name": "SSISExecutionRuntime", - "modelAsString": true - } - }, - "loggingLevel": { - "description": "The logging level of SSIS package execution.", - "type": "string" - }, - "environmentPath": { - "description": "The environment path to execute the SSIS package.", - "type": "string" - }, - "connectVia": { - "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" - }, - "projectParameters": { - "description": "The project level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "packageParameters": { - "description": "The package level parameters to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "projectConnectionManagers": { - "description": "The project level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "packageConnectionManagers": { - "description": "The package level connection managers to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISConnectionManager" - } - }, - "propertyOverrides": { - "description": "The property overrides to execute the SSIS package.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISPropertyOverride" - } - } - }, - "required": [ - "packageLocation", - "connectVia" - ] - }, - "SSISPackageLocation": { - "description": "SSIS package location.", - "type" : "object", - "properties": { - "packagePath": { - "description": "The SSIS package path.", - "type": "string" - } - }, - "required": [ - "packagePath" - ] - }, - "SSISConnectionManager": { - "description": "SSIS Connection Manager.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SSISExecutionParameter" - } - }, - "SSISExecutionParameter": { - "description": "SSIS execution parameter.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "value" - ] - }, - "SSISPropertyOverride": { - "description": "SSIS property override.", - "type": "object", - "properties": { - "value": { - "type": "object", - "description": "SSIS package property override value. Type: string (or Expression with resultType string)." - }, - "isSensitive": { - "type": "boolean", - "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" - } - }, - "required": [ - "value" - ] - }, - "CustomActivity": { - "description": "Custom activity type.", - "x-ms-discriminator-value": "Custom", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Custom activity properties.", - "$ref": "#/definitions/CustomActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "CustomActivityTypeProperties": { - "description": "Custom activity properties.", - "properties": { - "command": { - "type": "object", - "description": "Command for custom activity Type: string (or Expression with resultType string)." - }, - "resourceLinkedService": { - "description": "Resource linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "folderPath": { - "type": "object", - "description": "Folder path for resource files Type: string (or Expression with resultType string)." - }, - "referenceObjects": { - "description": "Reference objects", - "$ref": "#/definitions/CustomActivityReferenceObject" - }, - "extendedProperties": { - "description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "command" - ] - }, - "CustomActivityReferenceObject": { - "description": "Reference objects for custom activity", - "properties": { - "linkedServices": { - "description": "Linked service references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "datasets": { - "description": "Dataset references.", - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - } - } - }, - "SqlServerStoredProcedureActivity": { - "description": "SQL stored procedure activity type.", - "x-ms-discriminator-value": "SqlServerStoredProcedure", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "SQL stored procedure activity properties.", - "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" - } - }, - "required": [ - "typeProperties", - "linkedServiceName" - ] - }, - "SqlServerStoredProcedureActivityTypeProperties": { - "description": "SQL stored procedure activity properties.", - "properties": { - "storedProcedureName": { - "type": "object", - "description": "Stored procedure name. Type: string (or Expression with resultType string)." - }, - "storedProcedureParameters": { - "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/StoredProcedureParameter" - } - } - }, - "required": [ - "storedProcedureName" - ] - }, - "ExecutePipelineActivity": { - "x-ms-discriminator-value": "ExecutePipeline", - "description": "Execute pipeline activity.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Execute pipeline activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ExecutePipelineActivityTypeProperties": { - "description": "Execute pipeline activity properties.", - "properties": { - "pipeline": { - "description": "Pipeline reference.", - "$ref": "../datafactory.json#/definitions/PipelineReference" - }, - "parameters": { - "description": "Pipeline parameters.", - "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" - }, - "waitOnCompletion": { - "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", - "type": "boolean" - } - }, - "required": [ - "pipeline" - ] - }, - "LookupActivity": { - "x-ms-discriminator-value": "Lookup", - "description": "Lookup activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Lookup activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/LookupActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "LookupActivityTypeProperties": { - "description": "Lookup activity properties.", - "properties": { - "source": { - "description": "Dataset-specific source properties, same as copy activity source.", - "$ref": "#/definitions/CopySource" - }, - "dataset": { - "description": "Lookup activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "firstRowOnly": { - "type": "object", - "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." - } - }, - "required": [ - "source", - "dataset" - ] - }, - "WebActivityMethod": { - "description": "The list of HTTP methods supported by a WebActivity.", - "type": "string", - "enum": [ - "GET", - "POST", - "PUT", - "DELETE" - ], - "x-ms-enum": { - "name": "WebActivityMethod", - "modelAsString": true - } - }, - "WebActivity": { - "x-ms-discriminator-value": "WebActivity", - "description": "Web activity.", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Web activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WebActivityAuthentication": { - "description": "Web activity authentication properties.", - "properties": { - "type": { - "description": "Web activity authentication (Basic/ClientCertificate/MSI)", - "type": "string" - }, - "pfx": { - "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecureString" - }, - "username": { - "description": "Web activity authentication user name for basic authentication.", - "type": "string" - }, - "password": { - "description": "Password for the PFX file or basic authentication.", - "$ref": "../datafactory.json#/definitions/SecureString" - }, - "resource": { - "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", - "type": "string" - } - }, - "required": [ - "type" - ] - }, - "WebActivityTypeProperties": { - "description": "Web activity type properties.", - "properties": { - "method": { - "description": "Rest API method for target endpoint.", - "$ref": "#/definitions/WebActivityMethod" - }, - "url": { - "type": "object", - "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." - }, - "headers": { - "type": "object", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." - }, - "body": { - "type": "object", - "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." - }, - "authentication": { - "description": "Authentication method used for calling the endpoint.", - "$ref": "#/definitions/WebActivityAuthentication" - }, - "datasets": { - "type": "array", - "description": "List of datasets passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" - } - }, - "linkedServices": { - "type": "array", - "description": "List of linked services passed to web endpoint.", - "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - } - }, - "required": [ - "method", - "url" - ] - }, - "GetMetadataActivity": { - "x-ms-discriminator-value": "GetMetadata", - "description": "Activity to get metadata of dataset", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "description": "GetMetadata activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/GetMetadataActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "GetMetadataActivityTypeProperties": { - "description": "GetMetadata activity properties.", - "properties": { - "dataset": { - "description": "GetMetadata activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" - }, - "fieldList": { - "description": "Fields of metadata to get from dataset.", - "type": "array", - "items": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "dataset" - ] - }, - "IfConditionActivity": { - "x-ms-discriminator-value": "IfCondition", - "description": "This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "IfCondition activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/IfConditionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "IfConditionActivityTypeProperties": { - "description": "IfCondition activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "ifTrueActivities": { - "type": "array", - "description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.", - "items": { - "$ref": "#/definitions/Activity" - } - }, - "ifFalseActivities": { - "type": "array", - "description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression" - ] - }, - "ForEachActivity": { - "x-ms-discriminator-value": "ForEach", - "description": "This activity is used for iterating over a collection and execute given activities.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "ForEach activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ForEachActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ForEachActivityTypeProperties": { - "description": "ForEach activity properties.", - "properties": { - "isSequential": { - "description": "Should the loop be executed in sequence or in parallel (max 50)", - "type": "boolean" - }, - "batchCount": { - "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", - "type": "integer", - "maximum": 50 - }, - "items": { - "description": "Collection to iterate.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "activities": { - "type": "array", - "description": "List of activities to execute .", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "items", - "activities" - ] - }, - "AzureMLBatchExecutionActivity": { - "description": "Azure ML Batch Execution activity.", - "x-ms-discriminator-value": "AzureMLBatchExecution", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Batch Execution activity properties.", - "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLBatchExecutionActivityTypeProperties": { - "description": "Azure ML Batch Execution activity properties.", - "properties": { - "globalParameters": { - "description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "webServiceOutputs": { - "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - }, - "webServiceInputs": { - "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AzureMLWebServiceFile" - } - } - } - }, - "AzureMLWebServiceFile": { - "description": "Azure ML WebService Input/Output file", - "type": "object", - "properties": { - "filePath": { - "type": "object", - "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." - }, - "linkedServiceName": { - "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "required": [ - "linkedServiceName", - "filePath" - ] - }, - "AzureMLUpdateResourceActivity": { - "description": "Azure ML Update Resource management activity.", - "x-ms-discriminator-value": "AzureMLUpdateResource", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Azure ML Update Resource management activity properties.", - "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "AzureMLUpdateResourceActivityTypeProperties": { - "description": "Azure ML Update Resource activity properties.", - "properties": { - "trainedModelName": { - "type": "object", - "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." - }, - "trainedModelLinkedServiceName": { - "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "trainedModelFilePath": { - "type": "object", - "description": "The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "trainedModelName", - "trainedModelLinkedServiceName", - "trainedModelFilePath" - ] - }, - "DataLakeAnalyticsUSQLActivity": { - "description": "Data Lake Analytics U-SQL activity.", - "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Data Lake Analytics U-SQL activity properties.", - "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DataLakeAnalyticsUSQLActivityTypeProperties": { - "description": "DataLakeAnalyticsU-SQL activity properties.", - "properties": { - "scriptPath": { - "type": "object", - "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." - }, - "scriptLinkedService": { - "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - }, - "degreeOfParallelism": { - "type": "object", - "description": "The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1." - }, - "priority": { - "type": "object", - "description": "Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1." - }, - "parameters": { - "description": "Parameters for U-SQL job request.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - }, - "runtimeVersion": { - "type": "object", - "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." - }, - "compilationMode": { - "type": "object", - "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "scriptPath", - "scriptLinkedService" - ] - }, - "WaitActivity": { - "x-ms-discriminator-value": "Wait", - "description": "This activity suspends pipeline execution for the specified interval.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Wait activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/WaitActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "WaitActivityTypeProperties": { - "description": "Wait activity properties.", - "properties": { - "waitTimeInSeconds": { - "description": "Duration in seconds.", - "type": "integer" - } - }, - "required": [ - "waitTimeInSeconds" - ] - }, - "UntilActivity": { - "x-ms-discriminator-value": "Until", - "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Until activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/UntilActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "UntilActivityTypeProperties": { - "description": "Until activity properties.", - "properties": { - "expression": { - "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "timeout": { - "type": "object", - "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "activities": { - "type": "array", - "description": "List of activities to execute.", - "items": { - "$ref": "#/definitions/Activity" - } - } - }, - "required": [ - "expression", - "activities" - ] - }, - "FilterActivity": { - "x-ms-discriminator-value": "Filter", - "description": "Filter and return results from input array based on the conditions.", - "allOf": [ - { - "$ref": "#/definitions/ControlActivity" - } - ], - "properties": { - "typeProperties": { - "description": "Filter activity properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/FilterActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "FilterActivityTypeProperties": { - "description": "Fitler activity properties.", - "properties": { - "items": { - "description": "Input array on which filter should be applied.", - "$ref": "../datafactory.json#/definitions/Expression" - }, - "condition": { - "description": "Condition to be used for filtering the input.", - "$ref": "../datafactory.json#/definitions/Expression" - } - }, - "required": [ - "condition", - "items" - ] - }, - "DatabricksNotebookActivity": { - "description": "DatabricksNotebook activity.", - "x-ms-discriminator-value": "DatabricksNotebook", - "allOf": [ - { - "$ref": "#/definitions/ExecutionActivity" - } - ], - "properties": { - "typeProperties": { - "x-ms-client-flatten": true, - "description": "Databricks Notebook activity properties.", - "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DatabricksNotebookActivityTypeProperties": { - "description": "Databricks Notebook activity properties.", - "properties": { - "notebookPath": { - "type": "object", - "description": "The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string)." - }, - "baseParameters": { - "description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.", - "type": "object", - "additionalProperties": { - "type": "object", - "description": "Type: string (or Expression with resultType string)." - } - } - }, - "required": [ - "notebookPath" - ] - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Pipeline": { + "description": "A data factory pipeline.", + "type": "object", + "properties": { + "description": { + "description": "The description of the pipeline.", + "type": "string" + }, + "activities": { + "type": "array", + "description": "List of activities in pipeline.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "parameters": { + "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "description": "List of parameters for pipeline." + }, + "concurrency": { + "type": "integer", + "minimum": 1, + "description": "The max number of concurrent runs for the pipeline." + }, + "annotations": { + "description": "List of tags that can be used for describing the Pipeline.", + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "Activity": { + "discriminator": "type", + "description": "A pipeline activity.", + "type": "object", + "properties": { + "name": { + "description": "Activity name.", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type of activity." + }, + "description": { + "description": "Activity description.", + "type": "string" + }, + "dependsOn": { + "type": "array", + "description": "Activity depends on condition.", + "items": { + "$ref": "#/definitions/ActivityDependency" + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "name", + "type" + ] + }, + "ActivityDependency": { + "description": "Activity dependency information.", + "type": "object", + "properties": { + "activity": { + "description": "Activity name.", + "type": "string" + }, + "dependencyConditions": { + "type": "array", + "description": "Match-Condition for the dependency.", + "items": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Skipped", + "Completed" + ], + "x-ms-enum": { + "name": "DependencyCondition", + "modelAsString": true + } + } + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "activity", + "dependencyConditions" + ] + }, + "ControlActivity": { + "x-ms-discriminator-value": "Container", + "description": "Base class for all control activities like IfCondition, ForEach , Until.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": {} + }, + "ExecutionActivity": { + "x-ms-discriminator-value": "Execution", + "description": "Base class for all execution activities.", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "linkedServiceName": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "policy": { + "$ref": "#/definitions/ActivityPolicy", + "description": "Activity policy." + } + } + }, + "ActivityPolicy": { + "description": "Execution policy for an activity.", + "type": "object", + "properties": { + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "retry": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "retryIntervalInSeconds": { + "type": "integer", + "description": "Interval between each retry attempt (in seconds). The default is 30 sec.", + "minimum": 30, + "maximum": 86400 + }, + "secureOutput": { + "type": "boolean", + "description": "When set to true, Output from activity is considered as secure and will not be logged to monitoring." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "CopyActivity": { + "x-ms-discriminator-value": "Copy", + "description": "Copy activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Copy activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CopyActivityTypeProperties" + }, + "inputs": { + "type": "array", + "description": "List of inputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "outputs": { + "type": "array", + "description": "List of outputs for the activity.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + }, + "required": [ + "typeProperties" + ] + }, + "CopyActivityTypeProperties": { + "description": "Copy activity properties.", + "properties": { + "source": { + "description": "Copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "sink": { + "description": "Copy activity sink.", + "$ref": "#/definitions/CopySink" + }, + "translator": { + "description": "Copy activity translator. If not specificed, tabular translator is used.", + "$ref": "#/definitions/CopyTranslator" + }, + "enableStaging": { + "type": "object", + "description": "Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "stagingSettings": { + "description": "Specifies interim staging settings when EnableStaging is true.", + "$ref": "#/definitions/StagingSettings" + }, + "parallelCopies": { + "type": "object", + "description": "Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "cloudDataMovementUnits": { + "type": "object", + "description": "Maximum number of cloud data movement units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "enableSkipIncompatibleRow": { + "type": "object", + "description": "Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "redirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings when EnableSkipIncompatibleRow is true.", + "$ref": "#/definitions/RedirectIncompatibleRowSettings" + } + }, + "required": [ + "source", + "sink" + ] + }, + "CopySource": { + "discriminator": "type", + "description": "A copy activity source.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy source type." + }, + "sourceRetryCount": { + "type": "object", + "description": "Source retry count. Type: integer (or Expression with resultType integer)." + }, + "sourceRetryWait": { + "type": "object", + "description": "Source retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "AzureTableSource": { + "description": "A copy activity Azure Table source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "azureTableSourceQuery": { + "type": "object", + "description": "Azure Table source query. Type: string (or Expression with resultType string)." + }, + "azureTableSourceIgnoreTableNotFound": { + "type": "object", + "description": "Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "BlobSource": { + "description": "A copy activity Azure Blob source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "treatEmptyAsNull": { + "type": "object", + "description": "Treat empty as null. Type: boolean (or Expression with resultType boolean)." + }, + "skipHeaderLineCount": { + "type": "object", + "description": "Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer)." + }, + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "DocumentDbCollectionSource": { + "description": "A copy activity Document Database Collection source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Documents query. Type: string (or Expression with resultType string)." + }, + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSource": { + "description": "A copy activity Dynamics source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string)." + } + } + }, + "RelationalSource": { + "description": "A copy activity source for various relational databases.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceSource": { + "description": "A copy activity Salesforce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "readBehavior": { + "description": "The read behavior for the operation. Default is Query.", + "type": "string", + "enum": [ + "Query", + "QueryAll" + ], + "x-ms-enum": { + "name": "SalesforceSourceReadBehavior", + "modelAsString": true + } + } + } + }, + "SapCloudForCustomerSource": { + "description": "A copy activity source for SAP Cloud for Customer source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "SAP Cloud for Customer OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + } + } + }, + "SapEccSource": { + "description": "A copy activity source for SAP ECC source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "string", + "description": "SAP ECC OData query. For example, \"$top=1\". Type: string (or Expression with resultType string)." + } + } + }, + "SqlSource": { + "description": "A copy activity SQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + } + }, + "SqlDWSource": { + "description": "A copy activity SQL Data Warehouse source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "sqlReaderQuery": { + "type": "object", + "description": "SQL Data Warehouse reader query. Type: string (or Expression with resultType string)." + }, + "sqlReaderStoredProcedureName": { + "type": "object", + "description": "Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "type": "object", + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + } + } + }, + "FileSystemSource": { + "description": "A copy activity file system source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HdfsSource": { + "description": "A copy activity HDFS source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "distcpSettings": { + "description": "Specifies Distcp-related settings.", + "$ref": "#/definitions/DistcpSettings" + } + } + }, + "DistcpSettings": { + "description": "Distcp settings.", + "type": "object", + "properties": { + "resourceManagerEndpoint": { + "type": "object", + "description": "Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string)." + }, + "tempScriptPath": { + "type": "object", + "description": "Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string)." + }, + "distcpOptions": { + "type": "object", + "description": "Specifies the Distcp options. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "resourceManagerEndpoint", + "tempScriptPath" + ] + }, + "AzureMySqlSource": { + "description": "A copy activity Azure MySQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + } + } + }, + "OracleSource": { + "description": "A copy activity Oracle source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "oracleReaderQuery": { + "type": "object", + "description": "Oracle reader query. Type: string (or Expression with resultType string)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "WebSource": { + "description": "A copy activity source for web page table.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": {} + }, + "CassandraSource": { + "description": "A copy activity source for a Cassandra database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string)." + }, + "consistencyLevel": { + "description": "The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive.", + "type": "string", + "enum": [ + "ALL", + "EACH_QUORUM", + "QUORUM", + "LOCAL_QUORUM", + "ONE", + "TWO", + "THREE", + "LOCAL_ONE", + "SERIAL", + "LOCAL_SERIAL" + ], + "x-ms-enum": { + "name": "CassandraSourceReadConsistencyLevels", + "modelAsString": true + } + } + } + }, + "MongoDbSource": { + "description": "A copy activity source for a MongoDB database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSource": { + "description": "A copy activity Azure Data Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "HttpSource": { + "description": "A copy activity source for an HTTP file.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Serivce source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + } , + "AmazonRedshiftSource": { + "description": "A copy activity source for Amazon Redshift Source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Database query. Type: string (or Expression with resultType string)." + }, + "redshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "$ref": "#/definitions/RedshiftUnloadSettings" + } + } + }, + "RedshiftUnloadSettings": { + "description": "The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.", + "type": "object", + "properties": { + "s3LinkedServiceName": { + "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "bucketName": { + "type": "object", + "description": "The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "s3LinkedServiceName", + "bucketName" + ] + }, + "StoredProcedureParameter": { + "description": "SQL stored procedure parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "Stored procedure parameter value. Type: string (or Expression with resultType string)." + }, + "type": { + "description": "Stored procedure parameter type.", + "$ref": "#/definitions/StoredProcedureParameterType" + } + }, + "required": [ + "value" + ] + }, + "StoredProcedureParameterType": { + "description": "Stored procedure parameter type.", + "type": "string", + "enum": [ + "String", + "Int", + "Decimal", + "Guid", + "Boolean", + "Date" + ], + "x-ms-enum": { + "name": "StoredProcedureParameterType", + "modelAsString": true + } + }, + "CopySink": { + "discriminator": "type", + "description": "A copy activity sink.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy sink type." + }, + "writeBatchSize": { + "type": "object", + "description": "Write batch size. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "writeBatchTimeout": { + "type": "object", + "description": "Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "sinkRetryCount": { + "type": "object", + "description": "Sink retry count. Type: integer (or Expression with resultType integer)." + }, + "sinkRetryWait": { + "type": "object", + "description": "Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "SapCloudForCustomerSink": { + "description": "A copy activity SAP Cloud for Customer sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is 'Insert'.", + "type": "string", + "enum": [ + "Insert", + "Update" + ], + "x-ms-enum": { + "name": "SapCloudForCustomerSinkWriteBehavior", + "modelAsString": true + } + } + } + }, + "AzureQueueSink": { + "description": "A copy activity Azure Queue sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": {} + }, + "CopyBehaviorType": { + "description": "All available types of copy behavior.", + "type": "string", + "enum": [ + "PreserveHierarchy", + "FlattenHierarchy", + "MergeFiles" + ], + "x-ms-enum": { + "name": "CopyBehaviorType", + "modelAsString": true + } + }, + "AzureTableSink": { + "description": "A copy activity Azure Table sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "azureTableDefaultPartitionKeyValue": { + "type": "object", + "description": "Azure Table default partition key value. Type: string (or Expression with resultType string)." + }, + "azureTablePartitionKeyName": { + "type": "object", + "description": "Azure Table partition key name. Type: string (or Expression with resultType string)." + }, + "azureTableRowKeyName": { + "type": "object", + "description": "Azure Table row key name. Type: string (or Expression with resultType string)." + }, + "azureTableInsertType": { + "type": "object", + "description": "Azure Table insert type. Type: string (or Expression with resultType string)." + } + } + }, + "BlobSink": { + "description": "A copy activity Azure Blob sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "blobWriterOverwriteFiles": { + "type": "object", + "description": "Blob writer overwrite files. Type: boolean (or Expression with resultType boolean)." + }, + "blobWriterDateTimeFormat": { + "type": "object", + "description": "Blob writer date time format. Type: string (or Expression with resultType string)." + }, + "blobWriterAddHeader": { + "type": "object", + "description": "Blob writer add header. Type: boolean (or Expression with resultType boolean)." + }, + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "FileSystemSink": { + "description": "A copy activity file system sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "DocumentDbCollectionSink": { + "description": "A copy activity Document Database Collection sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "nestingSeparator": { + "type": "object", + "description": "Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string)." + } + } + }, + "SqlSink": { + "description": "A copy activity SQL sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "sqlWriterStoredProcedureName": { + "type": "object", + "description": "SQL writer stored procedure name. Type: string (or Expression with resultType string)." + }, + "sqlWriterTableType": { + "type": "object", + "description": "SQL writer table type. Type: string (or Expression with resultType string)." + }, + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "SQL stored procedure parameters.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + } + }, + "SqlDWSink": { + "description": "A copy activity SQL Data Warehouse sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "allowPolyBase": { + "type": "object", + "description": "Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean)." + }, + "polyBaseSettings": { + "description": "Specifies PolyBase-related settings when allowPolyBase is true.", + "$ref": "#/definitions/PolybaseSettings" + } + } + }, + "PolybaseSettings": { + "description": "PolyBase settings.", + "type": "object", + "properties": { + "rejectType": { + "$ref": "#/definitions/PolybaseSettingsRejectType", + "description": "Reject type." + }, + "rejectValue": { + "type": "object", + "description": "Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0." + }, + "rejectSampleValue": { + "type": "object", + "description": "Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "useTypeDefault": { + "type": "object", + "description": "Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + } + }, + "PolybaseSettingsRejectType": { + "description": "Indicates whether the RejectValue property is specified as a literal value or a percentage.", + "type": "string", + "enum": [ + "value", + "percentage" + ], + "x-ms-enum": { + "name": "PolybaseSettingsRejectType", + "modelAsString": true + } + }, + "StagingSettings": { + "description": "Staging settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Staging linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing the interim data. Type: string (or Expression with resultType string)." + }, + "enableCompression": { + "type": "object", + "description": "Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "RedirectIncompatibleRowSettings": { + "description": "Redirect incompatible row settings", + "type": "object", + "properties": { + "linkedServiceName": { + "type": "object", + "description": "Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string)." + }, + "path": { + "type": "object", + "description": "The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, + "OracleSink": { + "description": "A copy activity Oracle sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDataLakeStoreSink": { + "description": "A copy activity Azure Data Lake Store sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "copyBehavior": { + "description": "The type of copy behavior for copy sink.", + "$ref": "#/definitions/CopyBehaviorType" + } + } + }, + "AzureSearchIndexSink": { + "description": "A copy activity Azure Search Index sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "Specify the write behavior when upserting documents into Azure Search Index.", + "type": "string", + "enum": [ + "Merge", + "Upload" + ], + "x-ms-enum": { + "name": "AzureSearchIndexWriteBehaviorType", + "modelAsString": true + } + } + } + }, + "OdbcSink": { + "description": "A copy activity ODBC sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "A query to execute before starting the copy. Type: string (or Expression with resultType string)." + } + } + }, + "DynamicsSink": { + "description": "A copy activity Dynamics sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "writeBehavior" + ] + }, + "SalesforceSink": { + "description": "A copy activity Salesforce sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "writeBehavior": { + "description": "The write behavior for the operation. Default is Insert.", + "type": "string", + "enum": [ + "Insert", + "Upsert" + ], + "x-ms-enum": { + "name": "SalesforceSinkWriteBehavior", + "modelAsString": true + } + }, + "externalIdFieldName": { + "type": "object", + "description": "The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string)." + }, + "ignoreNullValues": { + "type": "object", + "description": "The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean)." + } + } + }, + "CopyTranslator": { + "discriminator": "type", + "description": "A copy activity translator.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Copy translator type." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TabularTranslator": { + "description": "A copy activity tabular translator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopyTranslator" + } + ], + "properties": { + "columnMappings": { + "type": "object", + "description": "Column mappings. Example: \"UserId: MyUserId, Group: MyGroup, Name: MyName\" Type: string (or Expression with resultType string)." + }, + "schemaMapping": { + "type": "object", + "description": "The schema mapping to map between tabular data and hierarchical data. Example: {\"Column1\": \"$.Column1\", \"Column2\": \"$.Column2.Property1\", \"Column3\": \"$.Column2.Property2\"}. Type: object (or Expression with resultType object)." + } + } + }, + "HDInsightHiveActivity": { + "description": "HDInsight Hive activity type.", + "x-ms-discriminator-value": "HDInsightHive", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Hive activity properties.", + "$ref": "#/definitions/HDInsightHiveActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightHiveActivityTypeProperties": { + "description": "HDInsight Hive activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Hive job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightActivityDebugInfoOption": { + "description": "The HDInsightActivityDebugInfoOption settings to use.", + "type": "string", + "enum": [ + "None", + "Always", + "Failure" + ], + "x-ms-enum": { + "name": "HDInsightActivityDebugInfoOption", + "modelAsString": true + } + }, + "HDInsightPigActivity": { + "description": "HDInsight Pig activity type.", + "x-ms-discriminator-value": "HDInsightPig", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight Pig activity properties.", + "$ref": "#/definitions/HDInsightPigActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightPigActivityTypeProperties": { + "description": "HDInsight Pig activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "scriptPath": { + "type": "object", + "description": "Script path. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "defines": { + "description": "Allows user to specify defines for Pig job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + } + }, + "HDInsightMapReduceActivity": { + "description": "HDInsight MapReduce activity type.", + "x-ms-discriminator-value": "HDInsightMapReduce", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight MapReduce activity properties.", + "$ref": "#/definitions/HDInsightMapReduceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightMapReduceActivityTypeProperties": { + "description": "HDInsight MapReduce activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "className": { + "type": "object", + "description": "Class name. Type: string (or Expression with resultType string)." + }, + "jarFilePath": { + "type": "object", + "description": "Jar path. Type: string (or Expression with resultType string)." + }, + "jarLinkedService": { + "description": "Jar linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "jarLibs": { + "description": "Jar libs.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for the MapReduce job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "className", + "jarFilePath" + ] + }, + "HDInsightStreamingActivity": { + "description": "HDInsight streaming activity type.", + "x-ms-discriminator-value": "HDInsightStreaming", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight streaming activity properties.", + "$ref": "#/definitions/HDInsightStreamingActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightStreamingActivityTypeProperties": { + "description": "HDInsight streaming activity properties.", + "properties": { + "storageLinkedServices": { + "description": "Storage linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "arguments": { + "description": "User specified arguments to HDInsightActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "mapper": { + "type": "object", + "description": "Mapper executable name. Type: string (or Expression with resultType string)." + }, + "reducer": { + "type": "object", + "description": "Reducer executable name. Type: string (or Expression with resultType string)." + }, + "input": { + "type": "object", + "description": "Input blob path. Type: string (or Expression with resultType string)." + }, + "output": { + "type": "object", + "description": "Output blob path. Type: string (or Expression with resultType string)." + }, + "filePaths": { + "description": "Paths to streaming job files. Can be directories.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "fileLinkedService": { + "description": "Linked service reference where the files are located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "combiner": { + "type": "object", + "description": "Combiner executable name. Type: string (or Expression with resultType string)." + }, + "commandEnvironment": { + "description": "Command line environment values.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "defines": { + "description": "Allows user to specify defines for streaming job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "mapper", + "reducer", + "input", + "output", + "filePaths" + ] + }, + "HDInsightSparkActivity": { + "description": "HDInsight Spark activity.", + "x-ms-discriminator-value": "HDInsightSpark", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "HDInsight spark activity properties.", + "$ref": "#/definitions/HDInsightSparkActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HDInsightSparkActivityTypeProperties": { + "description": "HDInsight spark activity properties.", + "properties": { + "rootPath": { + "type": "object", + "description": "The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string)." + }, + "entryFilePath": { + "type": "object", + "description": "The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string)." + }, + "arguments": { + "description": "The user-specified arguments to HDInsightSparkActivity.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "getDebugInfo": { + "$ref": "#/definitions/HDInsightActivityDebugInfoOption", + "description": "Debug info option." + }, + "sparkJobLinkedService": { + "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "className": { + "description": "The application's Java/Spark main class.", + "type": "string" + }, + "proxyUser": { + "type": "object", + "description": "The user to impersonate that will execute the job. Type: string (or Expression with resultType string)." + }, + "sparkConfig": { + "description": "Spark configuration property.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "rootPath", + "entryFilePath" + ] + }, + "ExecuteSSISPackageActivity": { + "description": "Execute SSIS package activity.", + "x-ms-discriminator-value": "ExecuteSSISPackage", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SSIS package activity properties.", + "$ref": "#/definitions/ExecuteSSISPackageActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecuteSSISPackageActivityTypeProperties": { + "description": "Execute SSIS package activity properties.", + "properties": { + "packageLocation": { + "description": "SSIS package location.", + "$ref": "#/definitions/SSISPackageLocation" + }, + "runtime": { + "description": "Specifies the runtime to execute SSIS package.", + "type": "string", + "enum": [ + "x64", + "x86" + ], + "x-ms-enum": { + "name": "SSISExecutionRuntime", + "modelAsString": true + } + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution.", + "type": "string" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package.", + "type": "string" + }, + "connectVia": { + "description": "The integration runtime reference.", + "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + }, + "projectParameters": { + "description": "The project level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "packageParameters": { + "description": "The package level parameters to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "projectConnectionManagers": { + "description": "The project level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "packageConnectionManagers": { + "description": "The package level connection managers to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISConnectionManager" + } + }, + "propertyOverrides": { + "description": "The property overrides to execute the SSIS package.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISPropertyOverride" + } + } + }, + "required": [ + "packageLocation", + "connectVia" + ] + }, + "SSISPackageLocation": { + "description": "SSIS package location.", + "type" : "object", + "properties": { + "packagePath": { + "description": "The SSIS package path.", + "type": "string" + } + }, + "required": [ + "packagePath" + ] + }, + "SSISConnectionManager": { + "description": "SSIS Connection Manager.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SSISExecutionParameter" + } + }, + "SSISExecutionParameter": { + "description": "SSIS execution parameter.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package execution parameter value. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "value" + ] + }, + "SSISPropertyOverride": { + "description": "SSIS property override.", + "type": "object", + "properties": { + "value": { + "type": "object", + "description": "SSIS package property override value. Type: string (or Expression with resultType string)." + }, + "isSensitive": { + "type": "boolean", + "description": "Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true" + } + }, + "required": [ + "value" + ] + }, + "CustomActivity": { + "description": "Custom activity type.", + "x-ms-discriminator-value": "Custom", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Custom activity properties.", + "$ref": "#/definitions/CustomActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "CustomActivityTypeProperties": { + "description": "Custom activity properties.", + "properties": { + "command": { + "type": "object", + "description": "Command for custom activity Type: string (or Expression with resultType string)." + }, + "resourceLinkedService": { + "description": "Resource linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "folderPath": { + "type": "object", + "description": "Folder path for resource files Type: string (or Expression with resultType string)." + }, + "referenceObjects": { + "description": "Reference objects", + "$ref": "#/definitions/CustomActivityReferenceObject" + }, + "extendedProperties": { + "description": "User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "command" + ] + }, + "CustomActivityReferenceObject": { + "description": "Reference objects for custom activity", + "properties": { + "linkedServices": { + "description": "Linked service references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "datasets": { + "description": "Dataset references.", + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + } + } + }, + "SqlServerStoredProcedureActivity": { + "description": "SQL stored procedure activity type.", + "x-ms-discriminator-value": "SqlServerStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "SQL stored procedure activity properties.", + "$ref": "#/definitions/SqlServerStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "typeProperties", + "linkedServiceName" + ] + }, + "SqlServerStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] + }, + "ExecutePipelineActivity": { + "x-ms-discriminator-value": "ExecutePipeline", + "description": "Execute pipeline activity.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Execute pipeline activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExecutePipelineActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ExecutePipelineActivityTypeProperties": { + "description": "Execute pipeline activity properties.", + "properties": { + "pipeline": { + "description": "Pipeline reference.", + "$ref": "../datafactory.json#/definitions/PipelineReference" + }, + "parameters": { + "description": "Pipeline parameters.", + "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" + }, + "waitOnCompletion": { + "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", + "type": "boolean" + } + }, + "required": [ + "pipeline" + ] + }, + "LookupActivity": { + "x-ms-discriminator-value": "Lookup", + "description": "Lookup activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Lookup activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LookupActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "LookupActivityTypeProperties": { + "description": "Lookup activity properties.", + "properties": { + "source": { + "description": "Dataset-specific source properties, same as copy activity source.", + "$ref": "#/definitions/CopySource" + }, + "dataset": { + "description": "Lookup activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "firstRowOnly": { + "type": "object", + "description": "Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean)." + } + }, + "required": [ + "source", + "dataset" + ] + }, + "WebActivityMethod": { + "description": "The list of HTTP methods supported by a WebActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE" + ], + "x-ms-enum": { + "name": "WebActivityMethod", + "modelAsString": true + } + }, + "WebActivity": { + "x-ms-discriminator-value": "WebActivity", + "description": "Web activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Web activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WebActivityAuthentication": { + "description": "Web activity authentication properties.", + "properties": { + "type": { + "description": "Web activity authentication (Basic/ClientCertificate/MSI)", + "type": "string" + }, + "pfx": { + "description": "Base64-encoded contents of a PFX file.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "username": { + "description": "Web activity authentication user name for basic authentication.", + "type": "string" + }, + "password": { + "description": "Password for the PFX file or basic authentication.", + "$ref": "../datafactory.json#/definitions/SecureString" + }, + "resource": { + "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "WebActivityTypeProperties": { + "description": "Web activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/WebActivityMethod" + }, + "url": { + "type": "object", + "description": "Web activity target endpoint and path. Type: string (or Expression with resultType string)." + }, + "headers": { + "type": "object", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + }, + "authentication": { + "description": "Authentication method used for calling the endpoint.", + "$ref": "#/definitions/WebActivityAuthentication" + }, + "datasets": { + "type": "array", + "description": "List of datasets passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "linkedServices": { + "type": "array", + "description": "List of linked services passed to web endpoint.", + "items": { + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + } + }, + "required": [ + "method", + "url" + ] + }, + "GetMetadataActivity": { + "x-ms-discriminator-value": "GetMetadata", + "description": "Activity to get metadata of dataset", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "GetMetadata activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GetMetadataActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GetMetadataActivityTypeProperties": { + "description": "GetMetadata activity properties.", + "properties": { + "dataset": { + "description": "GetMetadata activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "fieldList": { + "description": "Fields of metadata to get from dataset.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "dataset" + ] + }, + "IfConditionActivity": { + "x-ms-discriminator-value": "IfCondition", + "description": "This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "IfCondition activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/IfConditionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "IfConditionActivityTypeProperties": { + "description": "IfCondition activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "ifTrueActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + }, + "ifFalseActivities": { + "type": "array", + "description": "List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression" + ] + }, + "ForEachActivity": { + "x-ms-discriminator-value": "ForEach", + "description": "This activity is used for iterating over a collection and execute given activities.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "ForEach activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForEachActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ForEachActivityTypeProperties": { + "description": "ForEach activity properties.", + "properties": { + "isSequential": { + "description": "Should the loop be executed in sequence or in parallel (max 50)", + "type": "boolean" + }, + "batchCount": { + "description": "Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).", + "type": "integer", + "maximum": 50 + }, + "items": { + "description": "Collection to iterate.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "activities": { + "type": "array", + "description": "List of activities to execute .", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "items", + "activities" + ] + }, + "AzureMLBatchExecutionActivity": { + "description": "Azure ML Batch Execution activity.", + "x-ms-discriminator-value": "AzureMLBatchExecution", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Batch Execution activity properties.", + "$ref": "#/definitions/AzureMLBatchExecutionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLBatchExecutionActivityTypeProperties": { + "description": "Azure ML Batch Execution activity properties.", + "properties": { + "globalParameters": { + "description": "Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "webServiceOutputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + }, + "webServiceInputs": { + "description": "Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AzureMLWebServiceFile" + } + } + } + }, + "AzureMLWebServiceFile": { + "description": "Azure ML WebService Input/Output file", + "type": "object", + "properties": { + "filePath": { + "type": "object", + "description": "The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string)." + }, + "linkedServiceName": { + "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "linkedServiceName", + "filePath" + ] + }, + "AzureMLUpdateResourceActivity": { + "description": "Azure ML Update Resource management activity.", + "x-ms-discriminator-value": "AzureMLUpdateResource", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Azure ML Update Resource management activity properties.", + "$ref": "#/definitions/AzureMLUpdateResourceActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureMLUpdateResourceActivityTypeProperties": { + "description": "Azure ML Update Resource activity properties.", + "properties": { + "trainedModelName": { + "type": "object", + "description": "Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string)." + }, + "trainedModelLinkedServiceName": { + "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "trainedModelFilePath": { + "type": "object", + "description": "The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "trainedModelName", + "trainedModelLinkedServiceName", + "trainedModelFilePath" + ] + }, + "DataLakeAnalyticsUSQLActivity": { + "description": "Data Lake Analytics U-SQL activity.", + "x-ms-discriminator-value": "DataLakeAnalyticsU-SQL", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Data Lake Analytics U-SQL activity properties.", + "$ref": "#/definitions/DataLakeAnalyticsUSQLActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DataLakeAnalyticsUSQLActivityTypeProperties": { + "description": "DataLakeAnalyticsU-SQL activity properties.", + "properties": { + "scriptPath": { + "type": "object", + "description": "Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string)." + }, + "scriptLinkedService": { + "description": "Script linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "degreeOfParallelism": { + "type": "object", + "description": "The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "priority": { + "type": "object", + "description": "Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1." + }, + "parameters": { + "description": "Parameters for U-SQL job request.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "runtimeVersion": { + "type": "object", + "description": "Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string)." + }, + "compilationMode": { + "type": "object", + "description": "Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "scriptPath", + "scriptLinkedService" + ] + }, + "WaitActivity": { + "x-ms-discriminator-value": "Wait", + "description": "This activity suspends pipeline execution for the specified interval.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Wait activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WaitActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "WaitActivityTypeProperties": { + "description": "Wait activity properties.", + "properties": { + "waitTimeInSeconds": { + "description": "Duration in seconds.", + "type": "integer" + } + }, + "required": [ + "waitTimeInSeconds" + ] + }, + "UntilActivity": { + "x-ms-discriminator-value": "Until", + "description": "This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Until activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UntilActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "UntilActivityTypeProperties": { + "description": "Until activity properties.", + "properties": { + "expression": { + "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "timeout": { + "type": "object", + "description": "Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "activities": { + "type": "array", + "description": "List of activities to execute.", + "items": { + "$ref": "#/definitions/Activity" + } + } + }, + "required": [ + "expression", + "activities" + ] + }, + "FilterActivity": { + "x-ms-discriminator-value": "Filter", + "description": "Filter and return results from input array based on the conditions.", + "allOf": [ + { + "$ref": "#/definitions/ControlActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Filter activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FilterActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "FilterActivityTypeProperties": { + "description": "Fitler activity properties.", + "properties": { + "items": { + "description": "Input array on which filter should be applied.", + "$ref": "../datafactory.json#/definitions/Expression" + }, + "condition": { + "description": "Condition to be used for filtering the input.", + "$ref": "../datafactory.json#/definitions/Expression" + } + }, + "required": [ + "condition", + "items" + ] + }, + "DatabricksNotebookActivity": { + "description": "DatabricksNotebook activity.", + "x-ms-discriminator-value": "DatabricksNotebook", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Databricks Notebook activity properties.", + "$ref": "#/definitions/DatabricksNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DatabricksNotebookActivityTypeProperties": { + "description": "Databricks Notebook activity properties.", + "properties": { + "notebookPath": { + "type": "object", + "description": "The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string)." + }, + "baseParameters": { + "description": "Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.", + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + } + }, + "required": [ + "notebookPath" + ] + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..eed541ff50d3 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -1,427 +1,427 @@ -{ - "swagger": "2.0", - "info": { - "title": "DataFactoryManagementClient", - "version": "2017-09-01-preview" - }, - "paths": {}, - "definitions": { - "Trigger": { - "description": "Azure data factory nested object which contains information about creating pipeline run", - "type": "object", - "discriminator": "type", - "properties": { - "type": { - "type": "string", - "description": "Trigger type." - }, - "description": { - "description": "Trigger description.", - "type": "string" - }, - "runtimeState": { - "$ref": "#/definitions/TriggerRuntimeState", - "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", - "readOnly": true - } - }, - "additionalProperties": { - "type": "object" - }, - "required": [ - "type" - ] - }, - "TriggerRuntimeState": { - "type": "string", - "description": "Enumerates possible state of Triggers.", - "enum": [ - "Started", - "Stopped", - "Disabled" - ], - "x-ms-enum": { - "name": "TriggerRuntimeState", - "modelAsString": true - } - }, - "MultiplePipelineTrigger": { - "x-ms-discriminator-value": "MultiplePipelineTrigger", - "description": "Base class for all triggers that support one to many model for trigger to pipeline.", - "allOf": [ - { - "$ref": "#/definitions/Trigger" - } - ], - "properties": { - "pipelines": { - "type": "array", - "items": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" - }, - "description": "Pipelines that need to be started." - } - } - }, - "ScheduleTrigger": { - "description": "Trigger that creates pipeline runs periodically, on schedule.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MultiplePipelineTrigger" - } - ], - "properties": { - "typeProperties": { - "description": "Schedule Trigger properties.", - "x-ms-client-flatten": true, - "properties": { - "recurrence": { - "$ref": "#/definitions/ScheduleTriggerRecurrence", - "description": "Recurrence schedule configuration." - } - }, - "required": [ - "recurrence" - ] - } - }, - "required": [ - "typeProperties" - ] - }, - "ScheduleTriggerRecurrence": { - "type": "object", - "properties": { - "frequency": { - "$ref": "#/definitions/RecurrenceFrequency", - "description": "The frequency." - }, - "interval": { - "type": "integer", - "format": "int32", - "description": "The interval." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "The start time." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "The end time." - }, - "timeZone": { - "type": "string", - "description": "The time zone." - }, - "schedule": { - "$ref": "#/definitions/RecurrenceSchedule", - "description": "The recurrence schedule." - } - }, - "additionalProperties": { - "type": "object" - }, - "description": "The workflow trigger recurrence." - }, - "RecurrenceFrequency": { - "description": "Enumerates possible frequency option for the schedule trigger.", - "type": "string", - "enum": [ - "NotSpecified", - "Minute", - "Hour", - "Day", - "Week", - "Month", - "Year" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": true - } - }, - "RecurrenceSchedule": { - "type": "object", - "properties": { - "minutes": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The minutes." - }, - "hours": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The hours." - }, - "weekDays": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DaysOfWeek", - "modelAsString": false - } - }, - "description": "The days of the week." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "description": "The month days." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/RecurrenceScheduleOccurrence" - }, - "description": "The monthly occurrences." - } - }, - "additionalProperties": { - "type": "object" - }, - "description": "The recurrence schedule." - }, - "RecurrenceScheduleOccurrence": { - "type": "object", - "properties": { - "day": { - "$ref": "#/definitions/DayOfWeek", - "description": "The day of the week." - }, - "occurrence": { - "type": "integer", - "format": "int32", - "description": "The occurrence." - } - }, - "additionalProperties": { - "type": "object" - }, - "description": "The recurrence schedule occurence." - }, - "DayOfWeek": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - }, - "description": "The days of the week." - }, - "BlobTrigger": { - "description": "Trigger that runs everytime the selected Blob container changes.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MultiplePipelineTrigger" - } - ], - "properties": { - "typeProperties": { - "description": "Blob Trigger properties.", - "x-ms-client-flatten": true, - "properties": { - "folderPath": { - "description": "The path of the container/folder that will trigger the pipeline.", - "type": "string" - }, - "maxConcurrency": { - "description": "The max number of parallel files to handle when it is triggered.", - "type": "integer" - }, - "linkedService": { - "description": "The Azure Storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" - } - }, - "required": [ - "folderPath", - "maxConcurrency", - "linkedService" - ] - } - }, - "required": [ - "typeProperties" - ] - }, - "BlobEventsTrigger": - { - "description": "Trigger that runs everytime a Blob event occurs.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/MultiplePipelineTrigger" - } - ], - "properties": { - "typeProperties": - { - "description": "Blob Events Trigger properties.", - "x-ms-client-flatten": true, - "properties": { - "blobPathBeginsWith": { - "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", - "type": "string" - }, - "blobPathEndsWith": { - "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", - "type": "string" - }, - "events": { - "description": "The type of events that cause this trigger to fire.", - "$ref": "#/definitions/BlobEventTypes" - }, - "scope": { - "description": "The ARM resource ID of the Storage Account.", - "type": "string" - } - }, - "required": [ - "events", - "scope" - ] - } - }, - "required": [ - "typeProperties" - ] - }, - "BlobEventTypes": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Microsoft.Storage.BlobCreated", - "Microsoft.Storage.BlobDeleted" - ], - "x-ms-enum": { - "name": "BlobEventTypes", - "modelAsString": true - } - }, - "description": "Blob event types." - }, - "TumblingWindowTrigger": { - "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Trigger" - } - ], - "properties": { - "pipeline": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", - "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." - }, - "typeProperties": { - "description": "Tumbling Window Trigger properties.", - "x-ms-client-flatten": true, - "properties": { - "frequency": { - "$ref": "#/definitions/TumblingWindowFrequency", - "description": "The frequency of the time windows." - }, - "interval": { - "type": "integer", - "format": "int32", - "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." - }, - "delay": { - "type": "object", - "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "maxConcurrency": { - "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", - "type": "integer", - "minimum": 1, - "maximum": 50 - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Retry policy that will be applied for failed pipeline runs." - } - }, - "required": [ - "frequency", - "interval", - "startTime", - "maxConcurrency" - ] - } - }, - "required": [ - "pipeline", - "typeProperties" - ] - }, - "TumblingWindowFrequency": { - "description": "Enumerates possible frequency option for the tumbling window trigger.", - "type": "string", - "enum": [ - "Minute", - "Hour" - ], - "x-ms-enum": { - "name": "TumblingWindowFrequency", - "modelAsString": true - } - }, - "RetryPolicy": { - "description": "Execution policy for an activity.", - "properties": { - "count": { - "type": "object", - "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." - }, - "intervalInSeconds": { - "description": "Interval between retries in seconds. Default is 30.", - "type": "integer", - "minimum": 30, - "maximum": 86400 - } - } - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2017-09-01-preview" + }, + "paths": {}, + "definitions": { + "Trigger": { + "description": "Azure data factory nested object which contains information about creating pipeline run", + "type": "object", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Trigger type." + }, + "description": { + "description": "Trigger description.", + "type": "string" + }, + "runtimeState": { + "$ref": "#/definitions/TriggerRuntimeState", + "description": "Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.", + "readOnly": true + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "type" + ] + }, + "TriggerRuntimeState": { + "type": "string", + "description": "Enumerates possible state of Triggers.", + "enum": [ + "Started", + "Stopped", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerRuntimeState", + "modelAsString": true + } + }, + "MultiplePipelineTrigger": { + "x-ms-discriminator-value": "MultiplePipelineTrigger", + "description": "Base class for all triggers that support one to many model for trigger to pipeline.", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipelines": { + "type": "array", + "items": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" + }, + "description": "Pipelines that need to be started." + } + } + }, + "ScheduleTrigger": { + "description": "Trigger that creates pipeline runs periodically, on schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Schedule Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "recurrence": { + "$ref": "#/definitions/ScheduleTriggerRecurrence", + "description": "Recurrence schedule configuration." + } + }, + "required": [ + "recurrence" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "ScheduleTriggerRecurrence": { + "type": "object", + "properties": { + "frequency": { + "$ref": "#/definitions/RecurrenceFrequency", + "description": "The frequency." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time." + }, + "timeZone": { + "type": "string", + "description": "The time zone." + }, + "schedule": { + "$ref": "#/definitions/RecurrenceSchedule", + "description": "The recurrence schedule." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The workflow trigger recurrence." + }, + "RecurrenceFrequency": { + "description": "Enumerates possible frequency option for the schedule trigger.", + "type": "string", + "enum": [ + "NotSpecified", + "Minute", + "Hour", + "Day", + "Week", + "Month", + "Year" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": true + } + }, + "RecurrenceSchedule": { + "type": "object", + "properties": { + "minutes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The minutes." + }, + "hours": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The hours." + }, + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": false + } + }, + "description": "The days of the week." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "The month days." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/RecurrenceScheduleOccurrence" + }, + "description": "The monthly occurrences." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule." + }, + "RecurrenceScheduleOccurrence": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/DayOfWeek", + "description": "The day of the week." + }, + "occurrence": { + "type": "integer", + "format": "int32", + "description": "The occurrence." + } + }, + "additionalProperties": { + "type": "object" + }, + "description": "The recurrence schedule occurence." + }, + "DayOfWeek": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + }, + "description": "The days of the week." + }, + "BlobTrigger": { + "description": "Trigger that runs everytime the selected Blob container changes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": { + "description": "Blob Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "folderPath": { + "description": "The path of the container/folder that will trigger the pipeline.", + "type": "string" + }, + "maxConcurrency": { + "description": "The max number of parallel files to handle when it is triggered.", + "type": "integer" + }, + "linkedService": { + "description": "The Azure Storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + } + }, + "required": [ + "folderPath", + "maxConcurrency", + "linkedService" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventsTrigger": + { + "description": "Trigger that runs everytime a Blob event occurs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MultiplePipelineTrigger" + } + ], + "properties": { + "typeProperties": + { + "description": "Blob Events Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "blobPathBeginsWith": { + "description": "The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "blobPathEndsWith": { + "description": "The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.", + "type": "string" + }, + "events": { + "description": "The type of events that cause this trigger to fire.", + "$ref": "#/definitions/BlobEventTypes" + }, + "scope": { + "description": "The ARM resource ID of the Storage Account.", + "type": "string" + } + }, + "required": [ + "events", + "scope" + ] + } + }, + "required": [ + "typeProperties" + ] + }, + "BlobEventTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobDeleted" + ], + "x-ms-enum": { + "name": "BlobEventTypes", + "modelAsString": true + } + }, + "description": "Blob event types." + }, + "TumblingWindowTrigger": { + "description": "Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "pipeline": { + "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", + "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." + }, + "typeProperties": { + "description": "Tumbling Window Trigger properties.", + "x-ms-client-flatten": true, + "properties": { + "frequency": { + "$ref": "#/definitions/TumblingWindowFrequency", + "description": "The frequency of the time windows." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval of the time windows. The minimum interval allowed is 15 Minutes." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported." + }, + "delay": { + "type": "object", + "description": "Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "maxConcurrency": { + "description": "The max number of parallel time windows (ready for execution) for which a new run is triggered.", + "type": "integer", + "minimum": 1, + "maximum": 50 + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Retry policy that will be applied for failed pipeline runs." + } + }, + "required": [ + "frequency", + "interval", + "startTime", + "maxConcurrency" + ] + } + }, + "required": [ + "pipeline", + "typeProperties" + ] + }, + "TumblingWindowFrequency": { + "description": "Enumerates possible frequency option for the tumbling window trigger.", + "type": "string", + "enum": [ + "Minute", + "Hour" + ], + "x-ms-enum": { + "name": "TumblingWindowFrequency", + "modelAsString": true + } + }, + "RetryPolicy": { + "description": "Execution policy for an activity.", + "properties": { + "count": { + "type": "object", + "description": "Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0." + }, + "intervalInSeconds": { + "description": "Interval between retries in seconds. Default is 30.", + "type": "integer", + "minimum": 30, + "maximum": 86400 + } + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/ActivityRuns_ListByPipelineRun.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/ActivityRuns_ListByPipelineRun.json index 66248224917b..82d03d859567 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/ActivityRuns_ListByPipelineRun.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/ActivityRuns_ListByPipelineRun.json @@ -1,119 +1,119 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "startTime": "2017-09-13T17%3A54%3A57.0811551Z", - "endTime": "2017-09-13T18%3A07%3A59.6211018Z", - "status": null, - "activityName": null, - "linkedServiceName": null, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:20 GMT", - "x-ms-request-id": "016fce3e-f314-49ef-ac45-b10e494f1638", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14910", - "x-ms-correlation-request-id": "4ac11d09-28a5-405c-927b-88f1052fd56e" - }, - "body": { - "value": [ - { - "activityRunEnd": "2017-09-13T17:56:24.580131Z", - "activityName": "ExampleForeachActivity", - "activityRunStart": "2017-09-13T17:56:00.0758597Z", - "activityType": "ForEach", - "durationInMs": 24504, - "error": { - "errorCode": "", - "message": "", - "failureType": "", - "target": "ExampleForeachActivity" - }, - "activityRunId": "c80e9e66-3c32-4f79-a3bb-1677599e3bcd", - "input": { - "isSequential": true, - "items": "@pipeline().parameters.OutputBlobNameList", - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "@item()" - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "linkedServiceName": "", - "output": {}, - "pipelineName": "examplePipeline", - "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "status": "Succeeded" - }, - { - "activityRunEnd": "2017-09-13T17:56:20.0331458Z", - "activityName": "ExampleCopyActivity", - "activityRunStart": "2017-09-13T17:56:01.1719894Z", - "activityType": "Copy", - "durationInMs": 18861, - "error": { - "errorCode": "", - "message": "", - "failureType": "", - "target": "ExampleCopyActivity" - }, - "activityRunId": "b8bee996-143b-4f20-ace1-307cc1a0d75d", - "input": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "linkedServiceName": "", - "output": { - "dataRead": 142000, - "dataWritten": 142000, - "copyDuration": 4, - "throughput": 34.66797, - "errors": [] - }, - "pipelineName": "examplePipeline", - "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "status": "Succeeded" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "startTime": "2017-09-13T17%3A54%3A57.0811551Z", + "endTime": "2017-09-13T18%3A07%3A59.6211018Z", + "status": null, + "activityName": null, + "linkedServiceName": null, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:20 GMT", + "x-ms-request-id": "016fce3e-f314-49ef-ac45-b10e494f1638", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14910", + "x-ms-correlation-request-id": "4ac11d09-28a5-405c-927b-88f1052fd56e" + }, + "body": { + "value": [ + { + "activityRunEnd": "2017-09-13T17:56:24.580131Z", + "activityName": "ExampleForeachActivity", + "activityRunStart": "2017-09-13T17:56:00.0758597Z", + "activityType": "ForEach", + "durationInMs": 24504, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleForeachActivity" + }, + "activityRunId": "c80e9e66-3c32-4f79-a3bb-1677599e3bcd", + "input": { + "isSequential": true, + "items": "@pipeline().parameters.OutputBlobNameList", + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "@item()" + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "linkedServiceName": "", + "output": {}, + "pipelineName": "examplePipeline", + "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "status": "Succeeded" + }, + { + "activityRunEnd": "2017-09-13T17:56:20.0331458Z", + "activityName": "ExampleCopyActivity", + "activityRunStart": "2017-09-13T17:56:01.1719894Z", + "activityType": "Copy", + "durationInMs": 18861, + "error": { + "errorCode": "", + "message": "", + "failureType": "", + "target": "ExampleCopyActivity" + }, + "activityRunId": "b8bee996-143b-4f20-ace1-307cc1a0d75d", + "input": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "linkedServiceName": "", + "output": { + "dataRead": 142000, + "dataWritten": 142000, + "copyDuration": 4, + "throughput": 34.66797, + "errors": [] + }, + "pipelineName": "examplePipeline", + "pipelineRunId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "status": "Succeeded" + } + ] + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Create.json index 388224116a64..5c2375cd5ea4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Create.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Create.json @@ -1,84 +1,84 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "datasetName": "exampleDataset", - "ifMatch": null, - "dataset": { - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:54 GMT", - "x-ms-request-id": "a8bb197f-b00f-4add-a847-59f6aa0315ab", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1184", - "x-ms-correlation-request-id": "acdb3257-c6cb-44f1-8e14-afa3ebf471fa" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", - "name": "exampleDataset", - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - }, - "etag": "28031ea7-0000-0000-0000-59b9712a0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:54 GMT", + "x-ms-request-id": "a8bb197f-b00f-4add-a847-59f6aa0315ab", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1184", + "x-ms-correlation-request-id": "acdb3257-c6cb-44f1-8e14-afa3ebf471fa" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "28031ea7-0000-0000-0000-59b9712a0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Delete.json index 70b15819ad23..01acf52d92e9 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Delete.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "datasetName": "exampleDataset", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:27 GMT", - "x-ms-request-id": "70d3cf1f-bf14-40f5-bb56-1550a317ce8b", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1183", - "x-ms-correlation-request-id": "d56bf687-df32-4313-87ec-ff22ba9bd192" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:27 GMT", - "x-ms-request-id": "a2347ff3-4018-4815-b58a-9fbe3cdcab52", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1182", - "x-ms-correlation-request-id": "9b926944-88d9-4d77-b1a8-5540c803f933" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:27 GMT", + "x-ms-request-id": "70d3cf1f-bf14-40f5-bb56-1550a317ce8b", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1183", + "x-ms-correlation-request-id": "d56bf687-df32-4313-87ec-ff22ba9bd192" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:27 GMT", + "x-ms-request-id": "a2347ff3-4018-4815-b58a-9fbe3cdcab52", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1182", + "x-ms-correlation-request-id": "9b926944-88d9-4d77-b1a8-5540c803f933" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Get.json index 7a739126c796..01cdd9af81fe 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Get.json @@ -1,54 +1,54 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "datasetName": "exampleDataset", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:55 GMT", - "x-ms-request-id": "a60fc528-1652-4619-9477-f00ab05e9a24", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14912", - "x-ms-correlation-request-id": "949f7936-4ad4-49bc-8d2a-5f56a8938fba" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", - "name": "exampleDataset", - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "description": "Example description", - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - }, - "etag": "280320a7-0000-0000-0000-59b9712a0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:55 GMT", + "x-ms-request-id": "a60fc528-1652-4619-9477-f00ab05e9a24", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14912", + "x-ms-correlation-request-id": "949f7936-4ad4-49bc-8d2a-5f56a8938fba" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "280320a7-0000-0000-0000-59b9712a0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_ListByFactory.json index c30483cd0a32..70d4c0c3a340 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_ListByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_ListByFactory.json @@ -1,57 +1,57 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:55 GMT", - "x-ms-request-id": "624b9e0f-5b8e-4a08-8ff3-ead24e96658f", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14911", - "x-ms-correlation-request-id": "babd0c35-621b-4c3e-bc19-7e84ff1153e7" - }, - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", - "name": "exampleDataset", - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "description": "Example description", - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - }, - "etag": "280320a7-0000-0000-0000-59b9712a0000" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:55 GMT", + "x-ms-request-id": "624b9e0f-5b8e-4a08-8ff3-ead24e96658f", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14911", + "x-ms-correlation-request-id": "babd0c35-621b-4c3e-bc19-7e84ff1153e7" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "280320a7-0000-0000-0000-59b9712a0000" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Update.json index 65a505ee64f9..be928edcaddc 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Datasets_Update.json @@ -1,86 +1,86 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "datasetName": "exampleDataset", - "ifMatch": null, - "dataset": { - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "description": "Example description", - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:54 GMT", - "x-ms-request-id": "76cfa027-3792-424b-ae2b-ddcafe7034be", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1183", - "x-ms-correlation-request-id": "f3e7273d-9f29-4b0c-94bd-c3d13dec47ca" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", - "name": "exampleDataset", - "properties": { - "type": "AzureBlob", - "typeProperties": { - "folderPath": { - "value": "@dataset().MyFolderPath", - "type": "Expression" - }, - "fileName": { - "value": "@dataset().MyFileName", - "type": "Expression" - }, - "format": { - "type": "TextFormat" - } - }, - "description": "Example description", - "linkedServiceName": { - "referenceName": "exampleLinkedService", - "type": "LinkedServiceReference" - }, - "parameters": { - "MyFolderPath": { - "type": "String" - }, - "MyFileName": { - "type": "String" - } - } - }, - "etag": "280320a7-0000-0000-0000-59b9712a0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "datasetName": "exampleDataset", + "ifMatch": null, + "dataset": { + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:54 GMT", + "x-ms-request-id": "76cfa027-3792-424b-ae2b-ddcafe7034be", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1183", + "x-ms-correlation-request-id": "f3e7273d-9f29-4b0c-94bd-c3d13dec47ca" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/datasets/exampleDataset", + "name": "exampleDataset", + "properties": { + "type": "AzureBlob", + "typeProperties": { + "folderPath": { + "value": "@dataset().MyFolderPath", + "type": "Expression" + }, + "fileName": { + "value": "@dataset().MyFileName", + "type": "Expression" + }, + "format": { + "type": "TextFormat" + } + }, + "description": "Example description", + "linkedServiceName": { + "referenceName": "exampleLinkedService", + "type": "LinkedServiceReference" + }, + "parameters": { + "MyFolderPath": { + "type": "String" + }, + "MyFileName": { + "type": "String" + } + } + }, + "etag": "280320a7-0000-0000-0000-59b9712a0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json index 4f258178de19..fe00ab2a867f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_CreateOrUpdate.json @@ -1,54 +1,54 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "factory": { - "location": "East US", - "properties": { - "vstsConfiguration": { - "accountName": "msdata", - "projectName": "datafactory", - "repositoryName": "exampleRepo", - "collaborationBranch": "master", - "rootFolder": "/", - "lastCommitId": "", - "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:33:54 GMT", - "x-ms-request-id": "dc1954ed-a1d3-4437-bd73-480ffdf1ea5a", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1198", - "x-ms-correlation-request-id": "8d66d31c-23f3-4ac1-bc8c-1b6464342ad1" - }, - "body": { - "name": "exampleFactoryName", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview", - "vstsConfiguration": { - "accountName": "msdata", - "projectName": "datafactory", - "repositoryName": "exampleRepo", - "collaborationBranch": "master", - "rootFolder": "/", - "lastCommitId": "", - "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" - } - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "factory": { + "location": "East US", + "properties": { + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:54 GMT", + "x-ms-request-id": "dc1954ed-a1d3-4437-bd73-480ffdf1ea5a", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-correlation-request-id": "8d66d31c-23f3-4ac1-bc8c-1b6464342ad1" + }, + "body": { + "name": "exampleFactoryName", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview", + "vstsConfiguration": { + "accountName": "msdata", + "projectName": "datafactory", + "repositoryName": "exampleRepo", + "collaborationBranch": "master", + "rootFolder": "/", + "lastCommitId": "", + "tenantId": "12f988bf-86d1-41af-91ab-2d7cd011db49" + } + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/examplefactoryname", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Delete.json index 64401874a472..f0324c920cca 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:31 GMT", - "x-ms-request-id": "00d8b4cd-058f-4da8-a3a9-7a7a9ae772f0", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1177", - "x-ms-correlation-request-id": "9693bca3-4ee7-4501-865e-8411952d196b" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:31 GMT", - "x-ms-ratelimit-remaining-subscription-writes": "1176", - "x-ms-request-id": "95fce457-ddee-44a2-84a1-05c33b32d807", - "x-ms-correlation-request-id": "95fce457-ddee-44a2-84a1-05c33b32d807" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:31 GMT", + "x-ms-request-id": "00d8b4cd-058f-4da8-a3a9-7a7a9ae772f0", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1177", + "x-ms-correlation-request-id": "9693bca3-4ee7-4501-865e-8411952d196b" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:31 GMT", + "x-ms-ratelimit-remaining-subscription-writes": "1176", + "x-ms-request-id": "95fce457-ddee-44a2-84a1-05c33b32d807", + "x-ms-correlation-request-id": "95fce457-ddee-44a2-84a1-05c33b32d807" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Get.json index 70eefd444a95..17ce959ae588 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Get.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:33:55 GMT", - "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14993", - "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" - }, - "body": { - "name": "exampleFactoryName", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "8e58266a-de42-40d5-b3c4-c6a7e159cfba", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14993", + "x-ms-correlation-request-id": "5d862c55-4de9-4a46-969d-cf1ed3e235ed" + }, + "body": { + "name": "exampleFactoryName", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_List.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_List.json index 7143d4e423d4..093c22bd0754 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_List.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_List.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:33:56 GMT", - "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14992", - "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c" - }, - "body": { - "value": [ - { - "name": "exampleFactoryName", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - }, - { - "name": "yitzhangFactoryV2", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-05-08T21:03:32.7865115Z", - "version": "2017-03-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:56 GMT", + "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c" + }, + "body": { + "value": [ + { + "name": "exampleFactoryName", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + }, + { + "name": "yitzhangFactoryV2", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-05-08T21:03:32.7865115Z", + "version": "2017-03-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + ] + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ListByResourceGroup.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ListByResourceGroup.json index 22f4d7f3fcb5..47ed75a0ca07 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ListByResourceGroup.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_ListByResourceGroup.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:33:56 GMT", - "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14992", - "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c" - }, - "body": { - "value": [ - { - "name": "exampleFactoryName", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - }, - { - "name": "yitzhangFactoryV2", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-05-08T21:03:32.7865115Z", - "version": "2017-03-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:56 GMT", + "x-ms-request-id": "85e53e59-e56e-4878-a1ff-aaa27f52b466", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14992", + "x-ms-correlation-request-id": "471c3c55-1293-47bf-9662-33bb20f4b75c" + }, + "body": { + "value": [ + { + "name": "exampleFactoryName", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + }, + { + "name": "yitzhangFactoryV2", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-05-08T21:03:32.7865115Z", + "version": "2017-03-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/yitzhangFactoryV2", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + ] + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Update.json index bfddc74b4649..d99c2d5b03d3 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Factories_Update.json @@ -1,38 +1,38 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "factoryUpdateParameters": { - "tags": { - "exampleTag": "exampleValue" - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:33:55 GMT", - "x-ms-request-id": "3223701f-ce33-4a58-bb14-d3d53569d4f0", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1197", - "x-ms-correlation-request-id": "ec4ce622-a1dd-4c49-a324-17e8d4d1fe83" - }, - "body": { - "name": "exampleFactoryName", - "tags": { - "exampleTag": "exampleValue" - }, - "properties": { - "provisioningState": "Succeeded", - "createTime": "2017-09-13T17:33:54.0294655Z", - "version": "2017-09-01-preview" - }, - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", - "type": "Microsoft.DataFactory/factories", - "location": "East US" - } - } - } -} +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "factoryUpdateParameters": { + "tags": { + "exampleTag": "exampleValue" + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:33:55 GMT", + "x-ms-request-id": "3223701f-ce33-4a58-bb14-d3d53569d4f0", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1197", + "x-ms-correlation-request-id": "ec4ce622-a1dd-4c49-a324-17e8d4d1fe83" + }, + "body": { + "name": "exampleFactoryName", + "tags": { + "exampleTag": "exampleValue" + }, + "properties": { + "provisioningState": "Succeeded", + "createTime": "2017-09-13T17:33:54.0294655Z", + "version": "2017-09-01-preview" + }, + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleresourcegroup/providers/Microsoft.DataFactory/factories/exampleFactoryName", + "type": "Microsoft.DataFactory/factories", + "location": "East US" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Create.json index fdb36db8a753..1c930b55fe87 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Create.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Create.json @@ -1,75 +1,75 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "ifMatch": null, - "integrationRuntime": { - "properties": { - "type": "Managed", - "typeProperties": { - "computeProperties": { - "location": "West US", - "nodeSize": "Standard_D1_v2", - "numberOfNodes": 1, - "maxParallelExecutionsPerNode": 1 - }, - "ssisProperties": { - "catalogInfo": { - "catalogServerEndpoint": "yandongtestsvr.database.windows.net", - "catalogAdminUserName": "yanzhang", - "catalogAdminPassword": { - "type": "SecureString", - "value": "Passw0rd1" - }, - "catalogPricingTier": "S1" - }, - "licenseType": "BasePrice" - } - }, - "description": "A managed reserved integration runtime" - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:05:28 GMT", - "x-ms-request-id": "ef607971-0494-480e-82e7-73df0c671d9e", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", - "name": "exampleIntegrationRuntime", - "properties": { - "type": "Managed", - "typeProperties": { - "computeProperties": { - "location": "West US", - "nodeSize": "Standard_D1_v2", - "numberOfNodes": 1, - "maxParallelExecutionsPerNode": 1 - }, - "ssisProperties": { - "catalogInfo": { - "catalogServerEndpoint": "yandongtestsvr.database.windows.net", - "catalogAdminUserName": "yanzhang", - "catalogAdminPassword": { - "type": "SecureString", - "value": "**********" - }, - "catalogPricingTier": "S1" - }, - "licenseType": "BasePrice" - } - }, - "description": "A managed reserved integration runtime", - "state": "Initial" - }, - "etag": "0100333d-0000-0000-0000-5a1d0ab80000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "ifMatch": null, + "integrationRuntime": { + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "West US", + "nodeSize": "Standard_D1_v2", + "numberOfNodes": 1, + "maxParallelExecutionsPerNode": 1 + }, + "ssisProperties": { + "catalogInfo": { + "catalogServerEndpoint": "yandongtestsvr.database.windows.net", + "catalogAdminUserName": "yanzhang", + "catalogAdminPassword": { + "type": "SecureString", + "value": "Passw0rd1" + }, + "catalogPricingTier": "S1" + }, + "licenseType": "BasePrice" + } + }, + "description": "A managed reserved integration runtime" + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:05:28 GMT", + "x-ms-request-id": "ef607971-0494-480e-82e7-73df0c671d9e", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "West US", + "nodeSize": "Standard_D1_v2", + "numberOfNodes": 1, + "maxParallelExecutionsPerNode": 1 + }, + "ssisProperties": { + "catalogInfo": { + "catalogServerEndpoint": "yandongtestsvr.database.windows.net", + "catalogAdminUserName": "yanzhang", + "catalogAdminPassword": { + "type": "SecureString", + "value": "**********" + }, + "catalogPricingTier": "S1" + }, + "licenseType": "BasePrice" + } + }, + "description": "A managed reserved integration runtime", + "state": "Initial" + }, + "etag": "0100333d-0000-0000-0000-5a1d0ab80000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Delete.json index f74cf3a2f0d9..07f628fdfeeb 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Delete.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:29 GMT", - "x-ms-request-id": "6d1ee741-7850-484b-99cd-b42ef08fd18c", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1179", - "x-ms-correlation-request-id": "f931d2aa-0021-43ee-8005-2653da5e86d4" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:29 GMT", - "x-ms-request-id": "afb27d48-0c81-4e62-92c4-6fcb8c35c8a2", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1178", - "x-ms-correlation-request-id": "543d80b4-c9d0-418d-bf16-d2434abac0cb" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:29 GMT", + "x-ms-request-id": "6d1ee741-7850-484b-99cd-b42ef08fd18c", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1179", + "x-ms-correlation-request-id": "f931d2aa-0021-43ee-8005-2653da5e86d4" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:29 GMT", + "x-ms-request-id": "afb27d48-0c81-4e62-92c4-6fcb8c35c8a2", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1178", + "x-ms-correlation-request-id": "543d80b4-c9d0-418d-bf16-d2434abac0cb" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Get.json index 4bb75cbe58ce..2dd5cf34ea0e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Get.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:05:29 GMT", - "x-ms-request-id": "f0c62d3c-0df3-4b08-b860-d258752bdfec", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", - "name": "exampleIntegrationRuntime", - "properties": { - "type": "Managed", - "typeProperties": { - "computeProperties": { - "location": "West US", - "nodeSize": "Standard_D1_v2", - "numberOfNodes": 1, - "maxParallelExecutionsPerNode": 1 - }, - "ssisProperties": { - "catalogInfo": { - "catalogServerEndpoint": "yandongtestsvr.database.windows.net", - "catalogAdminUserName": "yanzhang", - "catalogAdminPassword": { - "type": "SecureString", - "value": "**********" - }, - "catalogPricingTier": "S1" - } - } - }, - "description": "A managed reserved integration runtime", - "state": "Initial" - }, - "etag": "0100333d-0000-0000-0000-5a1d0ab80000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:05:29 GMT", + "x-ms-request-id": "f0c62d3c-0df3-4b08-b860-d258752bdfec", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "West US", + "nodeSize": "Standard_D1_v2", + "numberOfNodes": 1, + "maxParallelExecutionsPerNode": 1 + }, + "ssisProperties": { + "catalogInfo": { + "catalogServerEndpoint": "yandongtestsvr.database.windows.net", + "catalogAdminUserName": "yanzhang", + "catalogAdminPassword": { + "type": "SecureString", + "value": "**********" + }, + "catalogPricingTier": "S1" + } + } + }, + "description": "A managed reserved integration runtime", + "state": "Initial" + }, + "etag": "0100333d-0000-0000-0000-5a1d0ab80000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetConnectionInfo.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetConnectionInfo.json index 2b7a72fe55d7..fcab30ad2e6b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetConnectionInfo.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetConnectionInfo.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:51 GMT", - "x-ms-request-id": "c38b64ae-4e0c-488d-8baa-6dc104cecdb2", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1190", - "x-ms-correlation-request-id": "500722f2-d4e5-4d88-b2d7-5231f158857c" - }, - "body": { - "isIdentityCertExprired": false - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:51 GMT", + "x-ms-request-id": "c38b64ae-4e0c-488d-8baa-6dc104cecdb2", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1190", + "x-ms-correlation-request-id": "500722f2-d4e5-4d88-b2d7-5231f158857c" + }, + "body": { + "isIdentityCertExprired": false + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetStatus.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetStatus.json index 142641316e27..8e47cfff5228 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetStatus.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_GetStatus.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:05:31 GMT", - "x-ms-request-id": "3a638bbf-1dfe-4def-b71d-96d121c42389", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "name": "exampleIntegrationRuntime", - "properties": { - "state": "Initial", - "type": "Managed", - "dataFactoryLocation": "West US", - "resourceUri": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", - "typeProperties": {} - } - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:05:31 GMT", + "x-ms-request-id": "3a638bbf-1dfe-4def-b71d-96d121c42389", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "name": "exampleIntegrationRuntime", + "properties": { + "state": "Initial", + "type": "Managed", + "dataFactoryLocation": "West US", + "resourceUri": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "typeProperties": {} + } + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListAuthKeys.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListAuthKeys.json index 1132cb84d5b1..7be259a66881 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListAuthKeys.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListAuthKeys.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:52 GMT", - "x-ms-request-id": "eecbf702-ed1d-4839-b235-ede3c87e0f49", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1189", - "x-ms-correlation-request-id": "a4a5f951-227f-4eb7-8471-a5dbe51c9b8b" - }, - "body": { - "authKey1": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@T5VHZgY8pqkdqoxok31dk8irrVOkhdnR6Ht8if1OebY=", - "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@W6N1MtqwVoVSSa2HYzmJrj/NArFcy0xaU392cIZX1sI=" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:52 GMT", + "x-ms-request-id": "eecbf702-ed1d-4839-b235-ede3c87e0f49", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1189", + "x-ms-correlation-request-id": "a4a5f951-227f-4eb7-8471-a5dbe51c9b8b" + }, + "body": { + "authKey1": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@T5VHZgY8pqkdqoxok31dk8irrVOkhdnR6Ht8if1OebY=", + "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@W6N1MtqwVoVSSa2HYzmJrj/NArFcy0xaU392cIZX1sI=" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListByFactory.json index cb1204c23a8c..80b3e6debccf 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_ListByFactory.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:05:28 GMT", - "x-ms-request-id": "a31dcf14-5eca-42c3-a0ac-5448c2f8b095", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", - "name": "exampleIntegrationRuntime", - "properties": { - "type": "Managed", - "typeProperties": { - "computeProperties": { - "location": "West US", - "nodeSize": "Standard_D1_v2", - "numberOfNodes": 1, - "maxParallelExecutionsPerNode": 1 - }, - "ssisProperties": { - "catalogInfo": { - "catalogServerEndpoint": "yandongtestsvr.database.windows.net", - "catalogAdminUserName": "yanzhang", - "catalogAdminPassword": { - "type": "SecureString", - "value": "**********" - }, - "catalogPricingTier": "S1" - } - } - }, - "description": "A managed reserved integration runtime", - "state": "Initial" - }, - "etag": "0100333d-0000-0000-0000-5a1d0ab80000" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:05:28 GMT", + "x-ms-request-id": "a31dcf14-5eca-42c3-a0ac-5448c2f8b095", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime", + "name": "exampleIntegrationRuntime", + "properties": { + "type": "Managed", + "typeProperties": { + "computeProperties": { + "location": "West US", + "nodeSize": "Standard_D1_v2", + "numberOfNodes": 1, + "maxParallelExecutionsPerNode": 1 + }, + "ssisProperties": { + "catalogInfo": { + "catalogServerEndpoint": "yandongtestsvr.database.windows.net", + "catalogAdminUserName": "yanzhang", + "catalogAdminPassword": { + "type": "SecureString", + "value": "**********" + }, + "catalogPricingTier": "S1" + } + } + }, + "description": "A managed reserved integration runtime", + "state": "Initial" + }, + "etag": "0100333d-0000-0000-0000-5a1d0ab80000" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_RegenerateAuthKey.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_RegenerateAuthKey.json index 65b17d3024e8..8c75991a54c0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_RegenerateAuthKey.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_RegenerateAuthKey.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "regenerateKeyParameters": { - "keyName": "authKey2" - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:52 GMT", - "x-ms-request-id": "706b5711-16e1-455b-808a-30cc120a061c", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1188", - "x-ms-correlation-request-id": "46ee8708-affc-403d-ab9f-53824b169fdf" - }, - "body": { - "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@IYLMSMWzzjQswOJHrTJNZc2SGwWla/SQ3QraZs3wqbw=" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "regenerateKeyParameters": { + "keyName": "authKey2" + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:52 GMT", + "x-ms-request-id": "706b5711-16e1-455b-808a-30cc120a061c", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1188", + "x-ms-correlation-request-id": "46ee8708-affc-403d-ab9f-53824b169fdf" + }, + "body": { + "authKey2": "IR@1baad24d-93e5-4074-8eeb-cd93fbb83b42@exampleFactoryName@eu@IYLMSMWzzjQswOJHrTJNZc2SGwWla/SQ3QraZs3wqbw=" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Start.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Start.json index 109d68ff9a3a..1df79c851773 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Start.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Start.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleManagedIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:17:56 GMT", - "Location": "https://adfrpnightly.svc.datafactory-test.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleManagedIntegrationRuntime/start/operationresults/9a070152cddb4c839d482ccfb76a7537?api-version=2017-09-01-preview", - "Retry-After": "15", - "x-ms-request-id": "aa8a8ed1-7b2e-40eb-b734-9b7a5f393aed", - "X-Content-Type-Options": "nosniff" - }, - "body": null - }, - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:39:18 GMT", - "x-ms-request-id": "a0190274-060e-43a0-84ea-403d1c0c4a06", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "name": "exampleManagedIntegrationRuntime", - "properties": { - "state": "Started", - "type": "Managed", - "typeProperties": { - "nodes": [ - { - "nodeId": "tvm-1650185656_1-20171128t071919z", - "status": "Unavailable", - "errors": [ - { - "time": "2017-11-28T07:38:41.50199Z", - "code": "AzureSqlConnectionFailure", - "parameters": [], - "message": "Sql Error Number: 18456" - } - ] - } - ], - "otherErrors": [], - "lastOperation": { - "type": "Start", - "startTime": "2017-11-28T07:17:58.6556933Z", - "result": "Succeeded", - "parameters": [] - }, - "state": "Started", - "createTime": "2017-11-28T07:17:56.5930407Z" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:17:56 GMT", + "Location": "https://adfrpnightly.svc.datafactory-test.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleManagedIntegrationRuntime/start/operationresults/9a070152cddb4c839d482ccfb76a7537?api-version=2017-09-01-preview", + "Retry-After": "15", + "x-ms-request-id": "aa8a8ed1-7b2e-40eb-b734-9b7a5f393aed", + "X-Content-Type-Options": "nosniff" + }, + "body": null + }, + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:39:18 GMT", + "x-ms-request-id": "a0190274-060e-43a0-84ea-403d1c0c4a06", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "name": "exampleManagedIntegrationRuntime", + "properties": { + "state": "Started", + "type": "Managed", + "typeProperties": { + "nodes": [ + { + "nodeId": "tvm-1650185656_1-20171128t071919z", + "status": "Unavailable", + "errors": [ + { + "time": "2017-11-28T07:38:41.50199Z", + "code": "AzureSqlConnectionFailure", + "parameters": [], + "message": "Sql Error Number: 18456" + } + ] + } + ], + "otherErrors": [], + "lastOperation": { + "type": "Start", + "startTime": "2017-11-28T07:17:58.6556933Z", + "result": "Succeeded", + "parameters": [] + }, + "state": "Started", + "createTime": "2017-11-28T07:17:56.5930407Z" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Stop.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Stop.json index e10363e38cdf..ba04fbbfbb27 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Stop.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Stop.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleManagedIntegrationRuntime", - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:39:21 GMT", - "Location": "https://adfrpnightly.svc.datafactory-test.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleManagedIntegrationRuntime/stop/operationresults/50799841b7f94497ae43291b791db7e0?api-version=2017-09-01-preview", - "Retry-After": "15", - "x-ms-request-id": "b36c64a2-3306-4374-b93f-ec91dbb3bf26", - "X-Content-Type-Options": "nosniff" - }, - "body": null - }, - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 07:40:23 GMT", - "x-ms-request-id": "bcff281c-ae61-4e2d-8a0c-044e34c1d04a", - "X-Content-Type-Options": "nosniff" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleManagedIntegrationRuntime", + "api-version": "2017-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:39:21 GMT", + "Location": "https://adfrpnightly.svc.datafactory-test.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleManagedIntegrationRuntime/stop/operationresults/50799841b7f94497ae43291b791db7e0?api-version=2017-09-01-preview", + "Retry-After": "15", + "x-ms-request-id": "b36c64a2-3306-4374-b93f-ec91dbb3bf26", + "X-Content-Type-Options": "nosniff" + }, + "body": null + }, + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 07:40:23 GMT", + "x-ms-request-id": "bcff281c-ae61-4e2d-8a0c-044e34c1d04a", + "X-Content-Type-Options": "nosniff" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Update.json index 00f3fd20ead5..fe703ec1a534 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/IntegrationRuntimes_Update.json @@ -1,74 +1,74 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "integrationRuntimeName": "exampleIntegrationRuntime", - "updateIntegrationRuntimeRequest": { - "autoUpdate": "Off", - "updateDelayOffset": "\"PT3H\"" - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Tue, 28 Nov 2017 06:05:14 GMT", - "x-ms-request-id": "2fcc5cb6-e236-4848-99b7-8c834a622144", - "X-Content-Type-Options": "nosniff" - }, - "body": { - "name": "exampleIntegrationRuntime", - "properties": { - "state": "Online", - "type": "SelfHosted", - "typeProperties": { - "autoUpdate": "Off", - "nodeCommunicationChannelEncryptionMode": "NonEncryption", - "taskQueueId": "c4f7521d-66cc-4d44-8aad-4d3679821c41", - "version": "3.2.6519.3", - "nodes": [ - { - "nodeName": "Node_1", - "machineName": "YANZHANG-02", - "hostServiceUri": "https://yanzhang-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/", - "status": "Online", - "capabilities": { - "serviceBusConnected": "True", - "httpsPortEnabled": "True", - "credentialInSync": "True", - "connectedToResourceManager": "True", - "nodeEnabled": "True" - }, - "versionStatus": "UpToDate", - "version": "3.2.6519.3", - "registerTime": "2017-11-28T05:54:38.5305162Z", - "lastConnectTime": "2017-11-28T06:04:53.3204752Z", - "lastStartTime": "2017-11-28T05:55:24.1066418Z", - "lastUpdateResult": "None", - "isActiveDispatcher": true, - "maxConcurrentJobs": 48 - } - ], - "updateDelayOffset": "PT3H", - "localTimeZoneOffset": "PT8H", - "serviceUrls": [ - "wu.frontend.int.clouddatahub-int.net", - "*.servicebus.windows.net" - ], - "versionStatus": "UpToDate", - "capabilities": { - "serviceBusConnected": "True", - "httpsPortEnabled": "True", - "credentialInSync": "True", - "connectedToResourceManager": "True", - "nodeEnabled": "True" - }, - "state": "Online", - "createTime": "2017-11-28T05:42:42.9629741Z" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "exampleIntegrationRuntime", + "updateIntegrationRuntimeRequest": { + "autoUpdate": "Off", + "updateDelayOffset": "\"PT3H\"" + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Tue, 28 Nov 2017 06:05:14 GMT", + "x-ms-request-id": "2fcc5cb6-e236-4848-99b7-8c834a622144", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "name": "exampleIntegrationRuntime", + "properties": { + "state": "Online", + "type": "SelfHosted", + "typeProperties": { + "autoUpdate": "Off", + "nodeCommunicationChannelEncryptionMode": "NonEncryption", + "taskQueueId": "c4f7521d-66cc-4d44-8aad-4d3679821c41", + "version": "3.2.6519.3", + "nodes": [ + { + "nodeName": "Node_1", + "machineName": "YANZHANG-02", + "hostServiceUri": "https://yanzhang-02.redmond.corp.microsoft.com:8050/HostServiceRemote.svc/", + "status": "Online", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "versionStatus": "UpToDate", + "version": "3.2.6519.3", + "registerTime": "2017-11-28T05:54:38.5305162Z", + "lastConnectTime": "2017-11-28T06:04:53.3204752Z", + "lastStartTime": "2017-11-28T05:55:24.1066418Z", + "lastUpdateResult": "None", + "isActiveDispatcher": true, + "maxConcurrentJobs": 48 + } + ], + "updateDelayOffset": "PT3H", + "localTimeZoneOffset": "PT8H", + "serviceUrls": [ + "wu.frontend.int.clouddatahub-int.net", + "*.servicebus.windows.net" + ], + "versionStatus": "UpToDate", + "capabilities": { + "serviceBusConnected": "True", + "httpsPortEnabled": "True", + "credentialInSync": "True", + "connectedToResourceManager": "True", + "nodeEnabled": "True" + }, + "state": "Online", + "createTime": "2017-11-28T05:42:42.9629741Z" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Create.json index 14fb70ebb5a6..019304dd2f4e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Create.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Create.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "linkedServiceName": "exampleLinkedService", - "ifMatch": null, - "linkedService": { - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=", - "type": "SecureString" - } - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:53 GMT", - "x-ms-request-id": "6c8f770c-0873-4d97-b9b1-f21eafa81eeb", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1186", - "x-ms-correlation-request-id": "866e9410-908e-4bf7-9d44-d3886325787b" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", - "name": "exampleLinkedService", - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "**********", - "type": "SecureString" - } - } - }, - "etag": "28031ca7-0000-0000-0000-59b971290000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=", + "type": "SecureString" + } + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:53 GMT", + "x-ms-request-id": "6c8f770c-0873-4d97-b9b1-f21eafa81eeb", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-correlation-request-id": "866e9410-908e-4bf7-9d44-d3886325787b" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "**********", + "type": "SecureString" + } + } + }, + "etag": "28031ca7-0000-0000-0000-59b971290000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Delete.json index 05d54346ce88..a20847c3074a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Delete.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "linkedServiceName": "exampleLinkedService", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:28 GMT", - "x-ms-request-id": "7383dae8-e077-4472-8f2e-91e1163dcbb2", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1181", - "x-ms-correlation-request-id": "af89dcb6-8a1e-498a-9b0c-3e866bd80f39" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:28 GMT", - "x-ms-request-id": "097cab57-d2b8-442d-90f0-2deb5e3733e5", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1180", - "x-ms-correlation-request-id": "3adc7b84-2fbe-4409-9481-bf2bd489f49f" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:28 GMT", + "x-ms-request-id": "7383dae8-e077-4472-8f2e-91e1163dcbb2", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1181", + "x-ms-correlation-request-id": "af89dcb6-8a1e-498a-9b0c-3e866bd80f39" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:28 GMT", + "x-ms-request-id": "097cab57-d2b8-442d-90f0-2deb5e3733e5", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1180", + "x-ms-correlation-request-id": "3adc7b84-2fbe-4409-9481-bf2bd489f49f" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Get.json index dcc14a77f57d..341797f698ef 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Get.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "linkedServiceName": "exampleLinkedService", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:53 GMT", - "x-ms-request-id": "d0d69de8-5acc-4ef4-bf5b-340328408cb2", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14914", - "x-ms-correlation-request-id": "a9524daa-23b7-48ef-985c-9f5a0136acea" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", - "name": "exampleLinkedService", - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "**********", - "type": "SecureString" - } - }, - "description": "Example description" - }, - "etag": "28031da7-0000-0000-0000-59b971290000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:53 GMT", + "x-ms-request-id": "d0d69de8-5acc-4ef4-bf5b-340328408cb2", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14914", + "x-ms-correlation-request-id": "a9524daa-23b7-48ef-985c-9f5a0136acea" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "**********", + "type": "SecureString" + } + }, + "description": "Example description" + }, + "etag": "28031da7-0000-0000-0000-59b971290000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_ListByFactory.json index 705be12f4f6b..83a2ed4669b2 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_ListByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_ListByFactory.json @@ -1,38 +1,38 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:54 GMT", - "x-ms-request-id": "b78883ab-f299-495e-ad30-804003deb775", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14913", - "x-ms-correlation-request-id": "4864247b-bf7c-4bc6-8d34-4a2bcebdb473" - }, - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", - "name": "exampleLinkedService", - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "**********", - "type": "SecureString" - } - }, - "description": "Example description" - }, - "etag": "28031da7-0000-0000-0000-59b971290000" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:54 GMT", + "x-ms-request-id": "b78883ab-f299-495e-ad30-804003deb775", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14913", + "x-ms-correlation-request-id": "4864247b-bf7c-4bc6-8d34-4a2bcebdb473" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "**********", + "type": "SecureString" + } + }, + "description": "Example description" + }, + "etag": "28031da7-0000-0000-0000-59b971290000" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Update.json index 79dda38b20eb..393716d41bbc 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/LinkedServices_Update.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "linkedServiceName": "exampleLinkedService", - "ifMatch": null, - "linkedService": { - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=", - "type": "SecureString" - } - }, - "description": "Example description" - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:53 GMT", - "x-ms-request-id": "1b67d903-bb60-42b1-a91a-3aec5ab6f3a5", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1185", - "x-ms-correlation-request-id": "5fe435da-a93c-498d-aee3-8118de9ef4aa" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", - "name": "exampleLinkedService", - "properties": { - "type": "AzureStorage", - "typeProperties": { - "connectionString": { - "value": "**********", - "type": "SecureString" - } - }, - "description": "Example description" - }, - "etag": "28031da7-0000-0000-0000-59b971290000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "linkedServiceName": "exampleLinkedService", + "ifMatch": null, + "linkedService": { + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=", + "type": "SecureString" + } + }, + "description": "Example description" + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:53 GMT", + "x-ms-request-id": "1b67d903-bb60-42b1-a91a-3aec5ab6f3a5", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1185", + "x-ms-correlation-request-id": "5fe435da-a93c-498d-aee3-8118de9ef4aa" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/linkedservices/exampleLinkedService", + "name": "exampleLinkedService", + "properties": { + "type": "AzureStorage", + "typeProperties": { + "connectionString": { + "value": "**********", + "type": "SecureString" + } + }, + "description": "Example description" + }, + "etag": "28031da7-0000-0000-0000-59b971290000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Operations_List.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Operations_List.json index a50ef1274688..94475c0b23b8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Operations_List.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Operations_List.json @@ -1,204 +1,204 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "api-version": "2017-09-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-ratelimit-remaining-tenant-reads": "14999", - "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" - }, - "body": { - "value": [ - { - "origin": "system", - "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/metricDefinitions/read", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "datafactories", - "operation": "Read datafactories metric definitions", - "description": "Gets the available metrics for datafactories" - }, - "properties": { - "serviceSpecification": { - "metricSpecifications": [ - { - "name": "SuccessfulRuns", - "displayName": "Successful Runs", - "displayDescription": "Number of successful runs.", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "PT1H", - "blobDuration": "P1D" - } - ] - }, - { - "name": "FailedRuns", - "displayName": "Failed Runs", - "displayDescription": "Number of failed runs.", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "PT1H", - "blobDuration": "P1D" - } - ] - } - ] - } - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/read", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "datafactories", - "operation": "Read diagnostic setting", - "description": "Gets the diagnostic setting for the resource" - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/write", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "datafactories", - "operation": "Write diagnostic setting", - "description": "Creates or updates the diagnostic setting for the resource" - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/logDefinitions/read", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "The log definition of factories", - "operation": "Read factories log definitions", - "description": "Gets the available logs for factories" - }, - "properties": { - "serviceSpecification": { - "logSpecifications": [ - { - "name": "ActivityRuns", - "displayName": "Pipeline activity runs log", - "blobDuration": "PT1H" - }, - { - "name": "PipelineRuns", - "displayName": "Pipeline runs log", - "blobDuration": "PT1H" - }, - { - "name": "TriggerRuns", - "displayName": "Trigger runs log", - "blobDuration": "PT1H" - } - ] - } - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/read", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "factories", - "operation": "Read diagnostic setting", - "description": "Gets the diagnostic setting for the resource" - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/write", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "factories", - "operation": "Write diagnostic setting", - "description": "Creates or updates the diagnostic setting for the resource" - } - }, - { - "origin": "system", - "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/metricDefinitions/read", - "display": { - "provider": "Microsoft.DataFactory", - "resource": "factories", - "operation": "Read metric definitions", - "description": "Gets the available metrics for factories" - }, - "properties": { - "serviceSpecification": { - "metricSpecifications": [ - { - "name": "PipelineFailedRuns", - "displayName": "Failed pipeline runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - }, - { - "name": "PipelineSucceededRuns", - "displayName": "Succeeded pipeline runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - }, - { - "name": "ActivityFailedRuns", - "displayName": "Failed activity runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - }, - { - "name": "ActivitySucceededRuns", - "displayName": "Succeeded activity runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - }, - { - "name": "TriggerFailedRuns", - "displayName": "Failed trigger runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - }, - { - "name": "TriggerSucceededRuns", - "displayName": "Succeeded trigger runs metrics", - "unit": "Count", - "aggregationType": "Total", - "enableRegionalMdmAccount": "false", - "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", - "sourceMdmNamespace": "ADFMetrics" - } - ] - } - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "api-version": "2017-09-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-ratelimit-remaining-tenant-reads": "14999", + "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd" + }, + "body": { + "value": [ + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Read datafactories metric definitions", + "description": "Gets the available metrics for datafactories" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "SuccessfulRuns", + "displayName": "Successful Runs", + "displayDescription": "Number of successful runs.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + }, + { + "name": "FailedRuns", + "displayName": "Failed Runs", + "displayDescription": "Number of failed runs.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1H", + "blobDuration": "P1D" + } + ] + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/datafactories/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "datafactories", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "The log definition of factories", + "operation": "Read factories log definitions", + "description": "Gets the available logs for factories" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "ActivityRuns", + "displayName": "Pipeline activity runs log", + "blobDuration": "PT1H" + }, + { + "name": "PipelineRuns", + "displayName": "Pipeline runs log", + "blobDuration": "PT1H" + }, + { + "name": "TriggerRuns", + "displayName": "Trigger runs log", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.DataFactory/factories/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataFactory", + "resource": "factories", + "operation": "Read metric definitions", + "description": "Gets the available metrics for factories" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "PipelineFailedRuns", + "displayName": "Failed pipeline runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + }, + { + "name": "PipelineSucceededRuns", + "displayName": "Succeeded pipeline runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + }, + { + "name": "ActivityFailedRuns", + "displayName": "Failed activity runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + }, + { + "name": "ActivitySucceededRuns", + "displayName": "Succeeded activity runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + }, + { + "name": "TriggerFailedRuns", + "displayName": "Failed trigger runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + }, + { + "name": "TriggerSucceededRuns", + "displayName": "Succeeded trigger runs metrics", + "unit": "Count", + "aggregationType": "Total", + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics" + } + ] + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_Get.json index 7b08b4c4f19f..faa6919980cf 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_Get.json @@ -1,37 +1,37 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:09 GMT", - "x-ms-request-id": "751b997c-7971-4c8e-bf84-cc4ee24ba2b7", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14911", - "x-ms-correlation-request-id": "5ce2fefe-900d-41b6-a4df-6e15421b1d9d" - }, - "body": { - "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "pipelineName": "examplePipeline", - "parameters": { - "OutputBlobNameList": "[\"exampleoutput.csv\"]" - }, - "invokedBy": { - "id": "be423891558d4c5294d4b49401a34620", - "name": "Manual" - }, - "runStart": "2017-09-13T17:55:57.1202147Z", - "runEnd": "2017-09-13T17:56:25.2051416Z", - "durationInMs": 28084, - "status": "Succeeded", - "message": "", - "lastUpdated": "2017-09-13T17:56:25.2051416Z" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:09 GMT", + "x-ms-request-id": "751b997c-7971-4c8e-bf84-cc4ee24ba2b7", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14911", + "x-ms-correlation-request-id": "5ce2fefe-900d-41b6-a4df-6e15421b1d9d" + }, + "body": { + "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "be423891558d4c5294d4b49401a34620", + "name": "Manual" + }, + "runStart": "2017-09-13T17:55:57.1202147Z", + "runEnd": "2017-09-13T17:56:25.2051416Z", + "durationInMs": 28084, + "status": "Succeeded", + "message": "", + "lastUpdated": "2017-09-13T17:56:25.2051416Z" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_QueryByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_QueryByFactory.json index 31159d50b245..ca5a6749cab5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_QueryByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/PipelineRuns_QueryByFactory.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "filterParameters": { - "lastUpdatedAfter": "2017-09-13T17:54:57.0811551Z", - "lastUpdatedBefore": "2017-09-13T18:07:59.6211018Z", - "filters": [ - { - "operand": "PipelineName", - "operator": "Equals", - "values": [ - "examplePipeline" - ] - } - ] - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:09 GMT", - "x-ms-request-id": "76f99b48-a79c-4af2-a0f0-0655fead6b24", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1199", - "x-ms-correlation-request-id": "988c8123-bf35-4601-a5d0-8958c1a2114d" - }, - "body": { - "value": [ - { - "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "pipelineName": "examplePipeline", - "parameters": { - "OutputBlobNameList": "[\"exampleoutput.csv\"]" - }, - "invokedBy": { - "id": "be423891558d4c5294d4b49401a34620", - "name": "Manual" - }, - "runStart": "2017-09-13T17:55:57.1202147Z", - "runEnd": "2017-09-13T17:56:25.2051416Z", - "durationInMs": 28084, - "status": "Succeeded", - "message": "", - "lastUpdated": "2017-09-13T17:56:25.2051416Z" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "filterParameters": { + "lastUpdatedAfter": "2017-09-13T17:54:57.0811551Z", + "lastUpdatedBefore": "2017-09-13T18:07:59.6211018Z", + "filters": [ + { + "operand": "PipelineName", + "operator": "Equals", + "values": [ + "examplePipeline" + ] + } + ] + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:09 GMT", + "x-ms-request-id": "76f99b48-a79c-4af2-a0f0-0655fead6b24", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-correlation-request-id": "988c8123-bf35-4601-a5d0-8958c1a2114d" + }, + "body": { + "value": [ + { + "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": "[\"exampleoutput.csv\"]" + }, + "invokedBy": { + "id": "be423891558d4c5294d4b49401a34620", + "name": "Manual" + }, + "runStart": "2017-09-13T17:55:57.1202147Z", + "runEnd": "2017-09-13T17:56:25.2051416Z", + "durationInMs": 28084, + "status": "Succeeded", + "message": "", + "lastUpdated": "2017-09-13T17:56:25.2051416Z" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Create.json index 790fa5f06cb8..73bbfb9138cf 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Create.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Create.json @@ -1,142 +1,142 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "pipelineName": "examplePipeline", - "ifMatch": null, - "pipeline": { - "properties": { - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:55 GMT", - "x-ms-request-id": "6cc3413e-9afa-487e-aeff-45bc6285470b", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1182", - "x-ms-correlation-request-id": "69c3f715-8fd9-4448-a8ee-becbde571aec" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", - "name": "examplePipeline", - "properties": { - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - }, - "etag": "280321a7-0000-0000-0000-59b9712b0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:55 GMT", + "x-ms-request-id": "6cc3413e-9afa-487e-aeff-45bc6285470b", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1182", + "x-ms-correlation-request-id": "69c3f715-8fd9-4448-a8ee-becbde571aec" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "properties": { + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "280321a7-0000-0000-0000-59b9712b0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_CreateRun.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_CreateRun.json index 5cb20139b560..8e14aee60322 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_CreateRun.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_CreateRun.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "pipelineName": "examplePipeline", - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "202": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:58 GMT", - "x-ms-request-id": "a420e4fd-ebe9-4758-8db7-852b4d06245e", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1180", - "x-ms-correlation-request-id": "15d0c07a-603f-42c7-98ba-872b0eff2326" - }, - "body": { - "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:58 GMT", + "x-ms-request-id": "a420e4fd-ebe9-4758-8db7-852b4d06245e", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1180", + "x-ms-correlation-request-id": "15d0c07a-603f-42c7-98ba-872b0eff2326" + }, + "body": { + "runId": "a420e4fd-ebe9-4758-8db7-852b4d06245e" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Delete.json index ea70656be79d..dbd3f94155c5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Delete.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "pipelineName": "examplePipeline", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:27 GMT", - "x-ms-request-id": "74ec3492-79c4-4028-9db1-fe7054e794d4", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1185", - "x-ms-correlation-request-id": "332e562a-b3f8-4f5d-852d-8bb1bfc6a798" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:27 GMT", - "x-ms-request-id": "86b4c1f6-9944-4cef-8147-170c856da5ec", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1184", - "x-ms-correlation-request-id": "5ba4c3d0-6e6a-465d-8ffd-592c38380527" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:27 GMT", + "x-ms-request-id": "74ec3492-79c4-4028-9db1-fe7054e794d4", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1185", + "x-ms-correlation-request-id": "332e562a-b3f8-4f5d-852d-8bb1bfc6a798" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:27 GMT", + "x-ms-request-id": "86b4c1f6-9944-4cef-8147-170c856da5ec", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1184", + "x-ms-correlation-request-id": "5ba4c3d0-6e6a-465d-8ffd-592c38380527" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Get.json index 4b5cab93476b..810f61a0427a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Get.json @@ -1,83 +1,83 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "pipelineName": "examplePipeline", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:56 GMT", - "x-ms-request-id": "f43d67bd-6702-4113-9b00-6ce0390f07ea", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14910", - "x-ms-correlation-request-id": "80f036bf-e6a7-4248-8ea4-fba427e19c79" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", - "name": "examplePipeline", - "properties": { - "description": "Example description", - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - }, - "etag": "280324a7-0000-0000-0000-59b9712b0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:56 GMT", + "x-ms-request-id": "f43d67bd-6702-4113-9b00-6ce0390f07ea", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14910", + "x-ms-correlation-request-id": "80f036bf-e6a7-4248-8ea4-fba427e19c79" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "280324a7-0000-0000-0000-59b9712b0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_ListByFactory.json index 3f0f53c1ffd2..1b7a1bd1c4c5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_ListByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_ListByFactory.json @@ -1,86 +1,86 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:56 GMT", - "x-ms-request-id": "a8129560-dc5c-4312-9c3e-22fc00f9033f", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14909", - "x-ms-correlation-request-id": "fa5fe506-baa4-4974-9d0a-0d79da341bd8" - }, - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", - "name": "examplePipeline", - "properties": { - "description": "Example description", - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - }, - "etag": "280324a7-0000-0000-0000-59b9712b0000" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:56 GMT", + "x-ms-request-id": "a8129560-dc5c-4312-9c3e-22fc00f9033f", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-correlation-request-id": "fa5fe506-baa4-4974-9d0a-0d79da341bd8" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "280324a7-0000-0000-0000-59b9712b0000" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Update.json index 8a4249c471c6..c23607b35d71 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Pipelines_Update.json @@ -1,144 +1,144 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "pipelineName": "examplePipeline", - "ifMatch": null, - "pipeline": { - "properties": { - "description": "Example description", - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:55:55 GMT", - "x-ms-request-id": "593b4383-377c-4e4d-8141-c6e76d313b8f", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1181", - "x-ms-correlation-request-id": "0bdb8812-2d23-4619-9582-2f16c2434e68" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", - "name": "examplePipeline", - "properties": { - "description": "Example description", - "activities": [ - { - "type": "ForEach", - "typeProperties": { - "isSequential": true, - "items": { - "value": "@pipeline().parameters.OutputBlobNameList", - "type": "Expression" - }, - "activities": [ - { - "type": "Copy", - "typeProperties": { - "source": { - "type": "BlobSource" - }, - "sink": { - "type": "BlobSink" - } - }, - "inputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": "examplecontainer.csv" - }, - "type": "DatasetReference" - } - ], - "outputs": [ - { - "referenceName": "exampleDataset", - "parameters": { - "MyFolderPath": "examplecontainer", - "MyFileName": { - "value": "@item()", - "type": "Expression" - } - }, - "type": "DatasetReference" - } - ], - "name": "ExampleCopyActivity" - } - ] - }, - "name": "ExampleForeachActivity" - } - ], - "parameters": { - "OutputBlobNameList": { - "type": "Array" - } - } - }, - "etag": "280324a7-0000-0000-0000-59b9712b0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "pipelineName": "examplePipeline", + "ifMatch": null, + "pipeline": { + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:55:55 GMT", + "x-ms-request-id": "593b4383-377c-4e4d-8141-c6e76d313b8f", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1181", + "x-ms-correlation-request-id": "0bdb8812-2d23-4619-9582-2f16c2434e68" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelines/examplePipeline", + "name": "examplePipeline", + "properties": { + "description": "Example description", + "activities": [ + { + "type": "ForEach", + "typeProperties": { + "isSequential": true, + "items": { + "value": "@pipeline().parameters.OutputBlobNameList", + "type": "Expression" + }, + "activities": [ + { + "type": "Copy", + "typeProperties": { + "source": { + "type": "BlobSource" + }, + "sink": { + "type": "BlobSink" + } + }, + "inputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": "examplecontainer.csv" + }, + "type": "DatasetReference" + } + ], + "outputs": [ + { + "referenceName": "exampleDataset", + "parameters": { + "MyFolderPath": "examplecontainer", + "MyFileName": { + "value": "@item()", + "type": "Expression" + } + }, + "type": "DatasetReference" + } + ], + "name": "ExampleCopyActivity" + } + ] + }, + "name": "ExampleForeachActivity" + } + ], + "parameters": { + "OutputBlobNameList": { + "type": "Array" + } + } + }, + "etag": "280324a7-0000-0000-0000-59b9712b0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Create.json index 011e2e9195a5..7ff873ae308f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Create.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Create.json @@ -1,79 +1,79 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "ifMatch": null, - "trigger": { - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:20.7835924Z", - "endTime": "2017-09-13T18:13:20.7835924Z", - "timeZone": "UTC" - } - }, - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ] - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:21 GMT", - "x-ms-request-id": "3581e103-fcbc-43a1-a8c2-dc086040d0de", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1198", - "x-ms-correlation-request-id": "8477d62a-5386-4c52-bf87-fc05a4f11b31" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", - "name": "exampleTrigger", - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:20.7835924Z", - "endTime": "2017-09-13T18:13:20.7835924Z", - "timeZone": "UTC" - } - }, - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ], - "runtimeState": "Stopped" - }, - "etag": "280327a7-0000-0000-0000-59b971bc0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:20.7835924Z", + "endTime": "2017-09-13T18:13:20.7835924Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ] + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:21 GMT", + "x-ms-request-id": "3581e103-fcbc-43a1-a8c2-dc086040d0de", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-correlation-request-id": "8477d62a-5386-4c52-bf87-fc05a4f11b31" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:20.7835924Z", + "endTime": "2017-09-13T18:13:20.7835924Z", + "timeZone": "UTC" + } + }, + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "280327a7-0000-0000-0000-59b971bc0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Delete.json index 3e18963f0c82..cb60f5853305 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Delete.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Delete.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:26 GMT", - "x-ms-request-id": "797186e9-af57-4d6c-8b4b-c363df9e9bf1", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1187", - "x-ms-correlation-request-id": "19402448-85f2-4872-b998-9c6c1e17f04d" - }, - "body": null - }, - "204": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:26 GMT", - "x-ms-request-id": "7d968b21-a030-4ba9-961b-7bbc799c0810", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1186", - "x-ms-correlation-request-id": "d66d750a-c28f-4be6-852a-30a67be744a1" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:26 GMT", + "x-ms-request-id": "797186e9-af57-4d6c-8b4b-c363df9e9bf1", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1187", + "x-ms-correlation-request-id": "19402448-85f2-4872-b998-9c6c1e17f04d" + }, + "body": null + }, + "204": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:26 GMT", + "x-ms-request-id": "7d968b21-a030-4ba9-961b-7bbc799c0810", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-correlation-request-id": "d66d750a-c28f-4be6-852a-30a67be744a1" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Get.json index 908ac82eaa49..36a1f0885074 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Get.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Get.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:22 GMT", - "x-ms-request-id": "bef4032e-cc3c-4ae7-b153-d1fdead84665", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14909", - "x-ms-correlation-request-id": "ca0d1b97-970b-494d-b7bb-b87692327db0" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", - "name": "exampleTrigger", - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:21.7240518Z", - "endTime": "2017-09-13T18:13:21.7240518Z", - "timeZone": "UTC" - } - }, - "description": "Example description", - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ], - "runtimeState": "Stopped" - }, - "etag": "28032ba7-0000-0000-0000-59b971bd0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:22 GMT", + "x-ms-request-id": "bef4032e-cc3c-4ae7-b153-d1fdead84665", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14909", + "x-ms-correlation-request-id": "ca0d1b97-970b-494d-b7bb-b87692327db0" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:21.7240518Z", + "endTime": "2017-09-13T18:13:21.7240518Z", + "timeZone": "UTC" + } + }, + "description": "Example description", + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "28032ba7-0000-0000-0000-59b971bd0000" + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListByFactory.json index 21eb0d2516b6..dfa5940accc0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListByFactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListByFactory.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:23 GMT", - "x-ms-request-id": "d56fed8c-4033-427d-9fda-d4b8fc53e6b1", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14908", - "x-ms-correlation-request-id": "3b7c2a31-c772-447e-a657-c572a8354119" - }, - "body": { - "value": [ - { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", - "name": "exampleTrigger", - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:21.7240518Z", - "endTime": "2017-09-13T18:13:21.7240518Z", - "timeZone": "UTC" - } - }, - "description": "Example description", - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ], - "runtimeState": "Started" - }, - "etag": "28032ca7-0000-0000-0000-59b971be0000" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:23 GMT", + "x-ms-request-id": "d56fed8c-4033-427d-9fda-d4b8fc53e6b1", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14908", + "x-ms-correlation-request-id": "3b7c2a31-c772-447e-a657-c572a8354119" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:21.7240518Z", + "endTime": "2017-09-13T18:13:21.7240518Z", + "timeZone": "UTC" + } + }, + "description": "Example description", + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Started" + }, + "etag": "28032ca7-0000-0000-0000-59b971be0000" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListRuns.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListRuns.json index 063a055a7ae8..34a790263c70 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListRuns.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_ListRuns.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "startTime": "2017-09-13T17%3A54%3A24.0440889Z", - "endTime": "2017-09-13T18%3A14%3A24.0440889Z", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:24 GMT", - "x-ms-request-id": "c82b86e6-2e81-46e4-8e28-356dd4a15f84", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-reads": "14855", - "x-ms-correlation-request-id": "165d9588-bcba-49ac-a3d9-0dcc49be6c8a" - }, - "body": { - "value": [ - { - "triggerName": "exampleTrigger", - "triggerRunId": "08586962812027443030287916742", - "triggerType": "ScheduleTrigger", - "triggerRunTimestamp": "2017-09-13T18:01:22.7219263Z", - "status": "Succeeded", - "message": "", - "properties": { - "TriggerTime": "09/13/2017 18:01:22", - "ScheduleTime": "09/13/2017 18:01:21" - }, - "triggeredPipelines": { - "examplePipeline": "0bf632a4-98c4-4179-935b-0b220d14fb19" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "startTime": "2017-09-13T17%3A54%3A24.0440889Z", + "endTime": "2017-09-13T18%3A14%3A24.0440889Z", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:24 GMT", + "x-ms-request-id": "c82b86e6-2e81-46e4-8e28-356dd4a15f84", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "14855", + "x-ms-correlation-request-id": "165d9588-bcba-49ac-a3d9-0dcc49be6c8a" + }, + "body": { + "value": [ + { + "triggerName": "exampleTrigger", + "triggerRunId": "08586962812027443030287916742", + "triggerType": "ScheduleTrigger", + "triggerRunTimestamp": "2017-09-13T18:01:22.7219263Z", + "status": "Succeeded", + "message": "", + "properties": { + "TriggerTime": "09/13/2017 18:01:22", + "ScheduleTime": "09/13/2017 18:01:21" + }, + "triggeredPipelines": { + "examplePipeline": "0bf632a4-98c4-4179-935b-0b220d14fb19" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Start.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Start.json index d28ea357a46f..7f0bbf8c93f3 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Start.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Start.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:23 GMT", - "x-ms-request-id": "13c76ae4-02b3-49a2-9f2a-d2c9f8511507", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1196", - "x-ms-correlation-request-id": "a28c76fa-3343-4bfb-9508-c92e2f374e79" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:23 GMT", + "x-ms-request-id": "13c76ae4-02b3-49a2-9f2a-d2c9f8511507", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1196", + "x-ms-correlation-request-id": "a28c76fa-3343-4bfb-9508-c92e2f374e79" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Stop.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Stop.json index ba735e337664..66d1db8a9c1f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Stop.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Stop.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 18:04:25 GMT", - "x-ms-request-id": "601d7eac-1d85-4196-a70b-76b9b906d6dd", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1188", - "x-ms-correlation-request-id": "c1f7bc90-6b21-464f-9c00-6e3869c0e63c" - }, - "body": null - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 18:04:25 GMT", + "x-ms-request-id": "601d7eac-1d85-4196-a70b-76b9b906d6dd", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1188", + "x-ms-correlation-request-id": "c1f7bc90-6b21-464f-9c00-6e3869c0e63c" + }, + "body": null + } + } } \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Update.json index bbcb18543db3..f4b5a5d0aa50 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Update.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/examples/Triggers_Update.json @@ -1,81 +1,81 @@ -{ - "parameters": { - "subscriptionId": "12345678-1234-1234-12345678abc", - "resourceGroupName": "exampleResourceGroup", - "factoryName": "exampleFactoryName", - "triggerName": "exampleTrigger", - "ifMatch": null, - "trigger": { - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:21.7240518Z", - "endTime": "2017-09-13T18:13:21.7240518Z", - "timeZone": "UTC" - } - }, - "description": "Example description", - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ] - } - }, - "api-version": "2017-09-01-preview" - }, - "responses": { - "200": { - "headers": { - "Date": "Wed, 13 Sep 2017 17:58:21 GMT", - "x-ms-request-id": "aa1aee23-db99-4aee-83e3-36b46ec02829", - "X-Content-Type-Options": "nosniff", - "x-ms-ratelimit-remaining-subscription-writes": "1197", - "x-ms-correlation-request-id": "f0eff525-3ed5-4488-aa0e-3284c2b400f6" - }, - "body": { - "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", - "name": "exampleTrigger", - "properties": { - "type": "ScheduleTrigger", - "typeProperties": { - "recurrence": { - "frequency": "Minute", - "interval": 4, - "startTime": "2017-09-13T17:57:21.7240518Z", - "endTime": "2017-09-13T18:13:21.7240518Z", - "timeZone": "UTC" - } - }, - "description": "Example description", - "pipelines": [ - { - "pipelineReference": { - "referenceName": "examplePipeline", - "type": "PipelineReference" - }, - "parameters": { - "OutputBlobNameList": [ - "exampleoutput.csv" - ] - } - } - ], - "runtimeState": "Stopped" - }, - "etag": "28032ba7-0000-0000-0000-59b971bd0000" - } - } - } +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "ifMatch": null, + "trigger": { + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:21.7240518Z", + "endTime": "2017-09-13T18:13:21.7240518Z", + "timeZone": "UTC" + } + }, + "description": "Example description", + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ] + } + }, + "api-version": "2017-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 13 Sep 2017 17:58:21 GMT", + "x-ms-request-id": "aa1aee23-db99-4aee-83e3-36b46ec02829", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1197", + "x-ms-correlation-request-id": "f0eff525-3ed5-4488-aa0e-3284c2b400f6" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger", + "name": "exampleTrigger", + "properties": { + "type": "ScheduleTrigger", + "typeProperties": { + "recurrence": { + "frequency": "Minute", + "interval": 4, + "startTime": "2017-09-13T17:57:21.7240518Z", + "endTime": "2017-09-13T18:13:21.7240518Z", + "timeZone": "UTC" + } + }, + "description": "Example description", + "pipelines": [ + { + "pipelineReference": { + "referenceName": "examplePipeline", + "type": "PipelineReference" + }, + "parameters": { + "OutputBlobNameList": [ + "exampleoutput.csv" + ] + } + } + ], + "runtimeState": "Stopped" + }, + "etag": "28032ba7-0000-0000-0000-59b971bd0000" + } + } + } } \ No newline at end of file diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json index f119f573ed26..a9ac1492ddf0 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_ListTableFragments.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "accountName": "contosoadla", - "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", - "databaseName": "master", - "schemaName": "dbo", - "tableName": "test_table_name", - "$filter": "test_filter", - "$top": 1, - "$skip": 1, - "$select": "test_select", - "$orderby": "test_orderby", - "$count": false - }, - "responses": { - "200": { - "body": { - "nextLink":"https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/tables/test_table_name/tablefragments?api-version=2016-11-01&%24skiptoken=", - "value": [{ - "parentId": "9d2d7abd-c641-4ddb-88ab-90cafdfe1c1b", - "fragmentId": "797d2643-eed9-4900-8090-0f8ddd9e8ba7", - "indexId": 1, - "size": 33786, - "rowCount": 1, - "createDate": "2017-10-11T06:38:31.567-07:00" - }] - } - } - } -} +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name", + "$filter": "test_filter", + "$top": 1, + "$skip": 1, + "$select": "test_select", + "$orderby": "test_orderby", + "$count": false + }, + "responses": { + "200": { + "body": { + "nextLink":"https://contosoadla.datalakeanalytics.net/catalog/usql/databases/master/schema/dbo/tables/test_table_name/tablefragments?api-version=2016-11-01&%24skiptoken=", + "value": [{ + "parentId": "9d2d7abd-c641-4ddb-88ab-90cafdfe1c1b", + "fragmentId": "797d2643-eed9-4900-8090-0f8ddd9e8ba7", + "indexId": 1, + "size": 33786, + "rowCount": 1, + "createDate": "2017-10-11T06:38:31.567-07:00" + }] + } + } + } +} diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json index cd981e4bd261..a201430f4c50 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTable.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "accountName": "contosoadla", - "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", - "databaseName": "master", - "schemaName": "dbo", - "tableName": "test_table_name" - }, - "responses": { - "200": { - "body": { - "totalRowCount": 1, - "totalColumnCount": 2, - "rows": [ - [ - "value_a", - "value_b" - ] - ], - "truncated": false, - "schema": [ - { - "name": "test_column_name", - "type": "test_data_type" - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name" + }, + "responses": { + "200": { + "body": { + "totalRowCount": 1, + "totalColumnCount": 2, + "rows": [ + [ + "value_a", + "value_b" + ] + ], + "truncated": false, + "schema": [ + { + "name": "test_column_name", + "type": "test_data_type" + } + ] + } + } + } +} diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json index e3d94341007c..6dca62bb70ce 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Catalog_PreviewTablePartition.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "accountName": "contosoadla", - "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", - "databaseName": "master", - "schemaName": "dbo", - "tableName": "test_table_name", - "partitionName": "test_partition_name" - }, - "responses": { - "200": { - "body": { - "totalRowCount": 1, - "totalColumnCount": 2, - "rows": [ - [ - "value_a", - "value_b" - ] - ], - "truncated": false, - "schema": [ - { - "name": "test_column_name", - "type": "test_data_type" - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2016-11-01", + "accountName": "contosoadla", + "adlaCatalogDnsSuffix": "azuredatalakeanalytics.net", + "databaseName": "master", + "schemaName": "dbo", + "tableName": "test_table_name", + "partitionName": "test_partition_name" + }, + "responses": { + "200": { + "body": { + "totalRowCount": 1, + "totalColumnCount": 2, + "rows": [ + [ + "value_a", + "value_b" + ] + ], + "truncated": false, + "schema": [ + { + "name": "test_column_name", + "type": "test_data_type" + } + ] + } + } + } +} diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json index 8da36e97e6e9..c4ba9c4d8672 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json @@ -1,8727 +1,8727 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-05-15", - "title": "DevTestLabsClient", - "description": "The DevTest Labs Client." - }, - "host": "management.azure.com", - "schemes": [ "https" ], - "consumes": [ "application/json" ], - "produces": [ "application/json" ], - "paths": { - "/providers/Microsoft.DevTestLab/operations": { - "get": { - "tags": [ "ProviderOperations" ], - "description": "Result of the request to list REST API operations", - "operationId": "ProviderOperations_List", - "parameters": [ { "$ref": "#/parameters/api-version" } ], - "responses": { - "200": { - "description": "Success", - "schema": { "$ref": "#/definitions/ProviderOperationResult" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs": { - "get": { - "tags": [ "Labs" ], - "description": "List labs in a subscription.", - "operationId": "Labs_ListBySubscription", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Lab]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Lab" - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}": { - "get": { - "tags": [ "Operations" ], - "description": "Get operation.", - "operationId": "Operations_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/locationName" }, - { - "name": "name", - "in": "path", - "description": "The name of the operation.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/OperationResult" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules": { - "get": { - "tags": [ "GlobalSchedules" ], - "description": "List schedules in a subscription.", - "operationId": "GlobalSchedules_ListBySubscription", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Schedule" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs": { - "get": { - "tags": [ "Labs" ], - "description": "List labs in a resource group.", - "operationId": "Labs_ListByResourceGroup", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Lab]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Lab" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources": { - "get": { - "tags": [ "ArtifactSources" ], - "description": "List artifact sources in a given lab.", - "operationId": "ArtifactSources_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=displayName)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[ArtifactSource]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ArtifactSource" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates": { - "get": { - "tags": [ "ArmTemplates" ], - "description": "List azure resource manager templates in a given artifact source.", - "operationId": "ArmTemplates_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "artifactSourceName", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=displayName)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[ArmTemplate]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ArmTemplate" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}": { - "get": { - "tags": [ "ArmTemplates" ], - "description": "Get azure resource manager template.", - "operationId": "ArmTemplates_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "artifactSourceName", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the azure Resource Manager template.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=displayName)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ArmTemplate" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts": { - "get": { - "tags": [ "Artifacts" ], - "description": "List artifacts in a given artifact source.", - "operationId": "Artifacts_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "artifactSourceName", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=title)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Artifact]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Artifact" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}": { - "get": { - "tags": [ "Artifacts" ], - "description": "Get artifact.", - "operationId": "Artifacts_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "artifactSourceName", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=title)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Artifact" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate": { - "post": { - "tags": [ "Artifacts" ], - "description": "Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.", - "operationId": "Artifacts_GenerateArmTemplate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "artifactSourceName", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact.", - "required": true, - "type": "string" - }, - { - "name": "generateArmTemplateRequest", - "in": "body", - "description": "Parameters for generating an ARM template for deploying artifacts.", - "required": true, - "schema": { "$ref": "#/definitions/GenerateArmTemplateRequest" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ArmTemplateInfo" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}": { - "get": { - "tags": [ "ArtifactSources" ], - "description": "Get artifact source.", - "operationId": "ArtifactSources_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=displayName)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ArtifactSource" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "ArtifactSources" ], - "description": "Create or replace an existing artifact source.", - "operationId": "ArtifactSources_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "artifactSource", - "in": "body", - "description": "Properties of an artifact source.", - "required": true, - "schema": { "$ref": "#/definitions/ArtifactSource" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ArtifactSource" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/ArtifactSource" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "ArtifactSources" ], - "description": "Delete artifact source.", - "operationId": "ArtifactSources_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "ArtifactSources" ], - "description": "Modify properties of artifact sources.", - "operationId": "ArtifactSources_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the artifact source.", - "required": true, - "type": "string" - }, - { - "name": "artifactSource", - "in": "body", - "description": "Properties of an artifact source.", - "required": true, - "schema": { "$ref": "#/definitions/ArtifactSourceFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ArtifactSource" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}": { - "get": { - "tags": [ "Costs" ], - "description": "Get cost.", - "operationId": "Costs_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the cost.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($expand=labCostDetails)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/LabCost" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Costs" ], - "description": "Create or replace an existing cost.", - "operationId": "Costs_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the cost.", - "required": true, - "type": "string" - }, - { - "name": "labCost", - "in": "body", - "description": "A cost item.", - "required": true, - "schema": { "$ref": "#/definitions/LabCost" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/LabCost" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/LabCost" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages": { - "get": { - "tags": [ "CustomImages" ], - "description": "List custom images in a given lab.", - "operationId": "CustomImages_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=vm)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[CustomImage]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/CustomImage" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}": { - "get": { - "tags": [ "CustomImages" ], - "description": "Get custom image.", - "operationId": "CustomImages_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the custom image.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=vm)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/CustomImage" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "CustomImages" ], - "description": "Create or replace an existing custom image. This operation can take a while to complete.", - "operationId": "CustomImages_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the custom image.", - "required": true, - "type": "string" - }, - { - "name": "customImage", - "in": "body", - "description": "A custom image.", - "required": true, - "schema": { "$ref": "#/definitions/CustomImage" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/CustomImage" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/CustomImage" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "CustomImages" ], - "description": "Delete custom image. This operation can take a while to complete.", - "operationId": "CustomImages_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the custom image.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas": { - "get": { - "tags": [ "Formulas" ], - "description": "List formulas in a given lab.", - "operationId": "Formulas_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=description)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Formula]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Formula" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}": { - "get": { - "tags": [ "Formulas" ], - "description": "Get formula.", - "operationId": "Formulas_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the formula.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=description)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Formula" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Formulas" ], - "description": "Create or replace an existing Formula. This operation can take a while to complete.", - "operationId": "Formulas_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the formula.", - "required": true, - "type": "string" - }, - { - "name": "formula", - "in": "body", - "description": "A formula for creating a VM, specifying an image base and other parameters", - "required": true, - "schema": { "$ref": "#/definitions/Formula" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Formula" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Formula" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "Formulas" ], - "description": "Delete formula.", - "operationId": "Formulas_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the formula.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages": { - "get": { - "tags": [ "GalleryImages" ], - "description": "List gallery images in a given lab.", - "operationId": "GalleryImages_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=author)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[GalleryImage]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/GalleryImage" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels": { - "get": { - "tags": [ "NotificationChannels" ], - "description": "List notificationchannels in a given lab.", - "operationId": "NotificationChannels_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[NotificationChannel]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/NotificationChannel" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}": { - "get": { - "tags": [ "NotificationChannels" ], - "description": "Get notificationchannel.", - "operationId": "NotificationChannels_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the notificationChannel.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/NotificationChannel" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "NotificationChannels" ], - "description": "Create or replace an existing notificationChannel.", - "operationId": "NotificationChannels_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the notificationChannel.", - "required": true, - "type": "string" - }, - { - "name": "notificationChannel", - "in": "body", - "description": "A notification.", - "required": true, - "schema": { "$ref": "#/definitions/NotificationChannel" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/NotificationChannel" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/NotificationChannel" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "NotificationChannels" ], - "description": "Delete notificationchannel.", - "operationId": "NotificationChannels_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the notificationChannel.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "NotificationChannels" ], - "description": "Modify properties of notificationchannels.", - "operationId": "NotificationChannels_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the notificationChannel.", - "required": true, - "type": "string" - }, - { - "name": "notificationChannel", - "in": "body", - "description": "A notification.", - "required": true, - "schema": { "$ref": "#/definitions/NotificationChannelFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/NotificationChannel" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify": { - "post": { - "tags": [ "NotificationChannels" ], - "description": "Send notification to provided channel.", - "operationId": "NotificationChannels_Notify", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the notificationChannel.", - "required": true, - "type": "string" - }, - { - "name": "notifyParameters", - "in": "body", - "description": "Properties for generating a Notification.", - "required": true, - "schema": { "$ref": "#/definitions/NotifyParameters" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies": { - "post": { - "tags": [ "PolicySets" ], - "description": "Evaluates lab policy.", - "operationId": "PolicySets_EvaluatePolicies", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "evaluatePoliciesRequest", - "in": "body", - "description": "Request body for evaluating a policy set.", - "required": true, - "schema": { "$ref": "#/definitions/EvaluatePoliciesRequest" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/EvaluatePoliciesResponse" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies": { - "get": { - "tags": [ "Policies" ], - "description": "List policies in a given policy set.", - "operationId": "Policies_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "policySetName", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=description)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Policy]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Policy" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}": { - "get": { - "tags": [ "Policies" ], - "description": "Get policy.", - "operationId": "Policies_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "policySetName", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the policy.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=description)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Policy" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Policies" ], - "description": "Create or replace an existing policy.", - "operationId": "Policies_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "policySetName", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the policy.", - "required": true, - "type": "string" - }, - { - "name": "policy", - "in": "body", - "description": "A Policy.", - "required": true, - "schema": { "$ref": "#/definitions/Policy" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Policy" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Policy" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "Policies" ], - "description": "Delete policy.", - "operationId": "Policies_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "policySetName", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the policy.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "Policies" ], - "description": "Modify properties of policies.", - "operationId": "Policies_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "policySetName", - "in": "path", - "description": "The name of the policy set.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the policy.", - "required": true, - "type": "string" - }, - { - "name": "policy", - "in": "body", - "description": "A Policy.", - "required": true, - "schema": { "$ref": "#/definitions/PolicyFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Policy" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules": { - "get": { - "tags": [ "Schedules" ], - "description": "List schedules in a given lab.", - "operationId": "Schedules_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Schedule" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}": { - "get": { - "tags": [ "Schedules" ], - "description": "Get schedule.", - "operationId": "Schedules_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Schedules" ], - "description": "Create or replace an existing schedule.", - "operationId": "Schedules_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/Schedule" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "Schedules" ], - "description": "Delete schedule.", - "operationId": "Schedules_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "Schedules" ], - "description": "Modify properties of schedules.", - "operationId": "Schedules_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/ScheduleFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute": { - "post": { - "tags": [ "Schedules" ], - "description": "Execute a schedule. This operation can take a while to complete.", - "operationId": "Schedules_Execute", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable": { - "post": { - "tags": [ "Schedules" ], - "description": "Lists all applicable schedules", - "operationId": "Schedules_ListApplicable", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners": { - "get": { - "tags": [ "ServiceRunners" ], - "description": "List service runners in a given lab.", - "operationId": "ServiceRunners_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[ServiceRunner]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ServiceRunner" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}": { - "get": { - "tags": [ "ServiceRunners" ], - "description": "Get service runner.", - "operationId": "ServiceRunners_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the service runner.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ServiceRunner" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "ServiceRunners" ], - "description": "Create or replace an existing Service runner.", - "operationId": "ServiceRunners_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the service runner.", - "required": true, - "type": "string" - }, - { - "name": "serviceRunner", - "in": "body", - "description": "A container for a managed identity to execute DevTest lab services.", - "required": true, - "schema": { "$ref": "#/definitions/ServiceRunner" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ServiceRunner" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/ServiceRunner" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "ServiceRunners" ], - "description": "Delete service runner.", - "operationId": "ServiceRunners_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the service runner.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users": { - "get": { - "tags": [ "Users" ], - "description": "List user profiles in a given lab.", - "operationId": "Users_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=identity)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[User]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/User" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}": { - "get": { - "tags": [ "Users" ], - "description": "Get user profile.", - "operationId": "Users_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=identity)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/User" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Users" ], - "description": "Create or replace an existing user profile.", - "operationId": "Users_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "user", - "in": "body", - "description": "Profile of a lab user.", - "required": true, - "schema": { "$ref": "#/definitions/User" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/User" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/User" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "Users" ], - "description": "Delete user profile. This operation can take a while to complete.", - "operationId": "Users_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ "Users" ], - "description": "Modify properties of user profiles.", - "operationId": "Users_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "user", - "in": "body", - "description": "Profile of a lab user.", - "required": true, - "schema": { "$ref": "#/definitions/UserFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/User" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks": { - "get": { - "tags": [ "Disks" ], - "description": "List disks in a given user profile.", - "operationId": "Disks_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=diskType)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Disk]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Disk" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}": { - "get": { - "tags": [ "Disks" ], - "description": "Get disk.", - "operationId": "Disks_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the disk.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=diskType)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Disk" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Disks" ], - "description": "Create or replace an existing disk. This operation can take a while to complete.", - "operationId": "Disks_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the disk.", - "required": true, - "type": "string" - }, - { - "name": "disk", - "in": "body", - "description": "A Disk.", - "required": true, - "schema": { "$ref": "#/definitions/Disk" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Disk" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Disk" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "Disks" ], - "description": "Delete disk. This operation can take a while to complete.", - "operationId": "Disks_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the disk.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach": { - "post": { - "tags": [ "Disks" ], - "description": "Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.", - "operationId": "Disks_Attach", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the disk.", - "required": true, - "type": "string" - }, - { - "name": "attachDiskProperties", - "in": "body", - "description": "Properties of the disk to attach.", - "required": true, - "schema": { "$ref": "#/definitions/AttachDiskProperties" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach": { - "post": { - "tags": [ "Disks" ], - "description": "Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.", - "operationId": "Disks_Detach", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the disk.", - "required": true, - "type": "string" - }, - { - "name": "detachDiskProperties", - "in": "body", - "description": "Properties of the disk to detach.", - "required": true, - "schema": { "$ref": "#/definitions/DetachDiskProperties" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments": { - "get": { - "tags": [ "Environments" ], - "description": "List environments in a given user profile.", - "operationId": "Environments_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[DtlEnvironment]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/DtlEnvironment" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}": { - "get": { - "tags": [ "Environments" ], - "description": "Get environment.", - "operationId": "Environments_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the environment.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/DtlEnvironment" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Environments" ], - "description": "Create or replace an existing environment. This operation can take a while to complete.", - "operationId": "Environments_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the environment.", - "required": true, - "type": "string" - }, - { - "name": "dtlEnvironment", - "in": "body", - "description": "An environment, which is essentially an ARM template deployment.", - "required": true, - "schema": { "$ref": "#/definitions/DtlEnvironment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/DtlEnvironment" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/DtlEnvironment" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "Environments" ], - "description": "Delete environment. This operation can take a while to complete.", - "operationId": "Environments_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the environment.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets": { - "get": { - "tags": [ "Secrets" ], - "description": "List secrets in a given user profile.", - "operationId": "Secrets_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=value)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Secret]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Secret" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}": { - "get": { - "tags": [ "Secrets" ], - "description": "Get secret.", - "operationId": "Secrets_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the secret.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=value)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Secret" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Secrets" ], - "description": "Create or replace an existing secret.", - "operationId": "Secrets_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the secret.", - "required": true, - "type": "string" - }, - { - "name": "secret", - "in": "body", - "description": "A secret.", - "required": true, - "schema": { "$ref": "#/definitions/Secret" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Secret" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Secret" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "Secrets" ], - "description": "Delete secret.", - "operationId": "Secrets_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "userName", - "in": "path", - "description": "The name of the user profile.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the secret.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines": { - "get": { - "tags": [ "VirtualMachines" ], - "description": "List virtual machines in a given lab.", - "operationId": "VirtualMachines_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabVirtualMachine]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/LabVirtualMachine" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}": { - "get": { - "tags": [ "VirtualMachines" ], - "description": "Get virtual machine.", - "operationId": "VirtualMachines_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/LabVirtualMachine" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "VirtualMachines" ], - "description": "Create or replace an existing Virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "labVirtualMachine", - "in": "body", - "description": "A virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/LabVirtualMachine" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/LabVirtualMachine" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/LabVirtualMachine" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "VirtualMachines" ], - "description": "Delete virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ "VirtualMachines" ], - "description": "Modify properties of virtual machines.", - "operationId": "VirtualMachines_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "labVirtualMachine", - "in": "body", - "description": "A virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/LabVirtualMachineFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/LabVirtualMachine" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Attach a new or existing data disk to virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_AddDataDisk", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "dataDiskProperties", - "in": "body", - "description": "Request body for adding a new or existing data disk to a virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/DataDiskProperties" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Apply artifacts to virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_ApplyArtifacts", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "applyArtifactsRequest", - "in": "body", - "description": "Request body for applying artifacts to a virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/ApplyArtifactsRequest" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Take ownership of an existing virtual machine This operation can take a while to complete.", - "operationId": "VirtualMachines_Claim", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Detach the specified disk from the virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_DetachDataDisk", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "detachDataDiskProperties", - "in": "body", - "description": "Request body for detaching data disk from a virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/DetachDataDiskProperties" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Lists all applicable schedules", - "operationId": "VirtualMachines_ListApplicableSchedules", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ApplicableSchedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Start a virtual machine. This operation can take a while to complete.", - "operationId": "VirtualMachines_Start", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop": { - "post": { - "tags": [ "VirtualMachines" ], - "description": "Stop a virtual machine This operation can take a while to complete.", - "operationId": "VirtualMachines_Stop", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules": { - "get": { - "tags": [ "VirtualMachineSchedules" ], - "description": "List schedules in a given virtual machine.", - "operationId": "VirtualMachineSchedules_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Schedule" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}": { - "get": { - "tags": [ "VirtualMachineSchedules" ], - "description": "Get schedule.", - "operationId": "VirtualMachineSchedules_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "VirtualMachineSchedules" ], - "description": "Create or replace an existing schedule.", - "operationId": "VirtualMachineSchedules_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/Schedule" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "VirtualMachineSchedules" ], - "description": "Delete schedule.", - "operationId": "VirtualMachineSchedules_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "VirtualMachineSchedules" ], - "description": "Modify properties of schedules.", - "operationId": "VirtualMachineSchedules_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/ScheduleFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute": { - "post": { - "tags": [ "VirtualMachineSchedules" ], - "description": "Execute a schedule. This operation can take a while to complete.", - "operationId": "VirtualMachineSchedules_Execute", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "virtualMachineName", - "in": "path", - "description": "The name of the virtual machine.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks": { - "get": { - "tags": [ "VirtualNetworks" ], - "description": "List virtual networks in a given lab.", - "operationId": "VirtualNetworks_List", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[VirtualNetwork]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/VirtualNetwork" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}": { - "get": { - "tags": [ "VirtualNetworks" ], - "description": "Get virtual network.", - "operationId": "VirtualNetworks_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual network.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/VirtualNetwork" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "VirtualNetworks" ], - "description": "Create or replace an existing virtual network. This operation can take a while to complete.", - "operationId": "VirtualNetworks_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual network.", - "required": true, - "type": "string" - }, - { - "name": "virtualNetwork", - "in": "body", - "description": "A virtual network.", - "required": true, - "schema": { "$ref": "#/definitions/VirtualNetwork" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/VirtualNetwork" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/VirtualNetwork" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "VirtualNetworks" ], - "description": "Delete virtual network. This operation can take a while to complete.", - "operationId": "VirtualNetworks_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual network.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ "VirtualNetworks" ], - "description": "Modify properties of virtual networks.", - "operationId": "VirtualNetworks_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "labName", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the virtual network.", - "required": true, - "type": "string" - }, - { - "name": "virtualNetwork", - "in": "body", - "description": "A virtual network.", - "required": true, - "schema": { "$ref": "#/definitions/VirtualNetworkFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/VirtualNetwork" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}": { - "get": { - "tags": [ "Labs" ], - "description": "Get lab.", - "operationId": "Labs_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Lab" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "Labs" ], - "description": "Create or replace an existing lab. This operation can take a while to complete.", - "operationId": "Labs_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "lab", - "in": "body", - "description": "A lab.", - "required": true, - "schema": { "$ref": "#/definitions/Lab" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Lab" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Lab" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ "Labs" ], - "description": "Delete lab. This operation can take a while to complete.", - "operationId": "Labs_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "202": { "description": "Accepted" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ "Labs" ], - "description": "Modify properties of labs.", - "operationId": "Labs_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "lab", - "in": "body", - "description": "A lab.", - "required": true, - "schema": { "$ref": "#/definitions/LabFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Lab" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm": { - "post": { - "tags": [ "Labs" ], - "description": "Claim a random claimable virtual machine in the lab. This operation can take a while to complete.", - "operationId": "Labs_ClaimAnyVm", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment": { - "post": { - "tags": [ "Labs" ], - "description": "Create virtual machines in a lab. This operation can take a while to complete.", - "operationId": "Labs_CreateEnvironment", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "labVirtualMachineCreationParameter", - "in": "body", - "description": "Properties for creating a virtual machine.", - "required": true, - "schema": { "$ref": "#/definitions/LabVirtualMachineCreationParameter" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage": { - "post": { - "tags": [ "Labs" ], - "description": "Exports the lab resource usage into a storage account This operation can take a while to complete.", - "operationId": "Labs_ExportResourceUsage", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "exportResourceUsageParameters", - "in": "body", - "description": "The parameters of the export operation.", - "required": true, - "schema": { "$ref": "#/definitions/ExportResourceUsageParameters" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri": { - "post": { - "tags": [ "Labs" ], - "description": "Generate a URI for uploading custom disk images to a Lab.", - "operationId": "Labs_GenerateUploadUri", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { - "name": "generateUploadUriParameter", - "in": "body", - "description": "Properties for generating an upload URI.", - "required": true, - "schema": { "$ref": "#/definitions/GenerateUploadUriParameter" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/GenerateUploadUriResponse" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds": { - "post": { - "tags": [ "Labs" ], - "description": "List disk images available for custom image creation.", - "operationId": "Labs_ListVhds", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the lab.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabVhd]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules": { - "get": { - "tags": [ "GlobalSchedules" ], - "description": "List schedules in a resource group.", - "operationId": "GlobalSchedules_ListByResourceGroup", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "The filter to apply to the operation.", - "required": false, - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "The maximum number of resources to return from the operation.", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "description": "The ordering expression for the results, using OData notation.", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Schedule" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}": { - "get": { - "tags": [ "GlobalSchedules" ], - "description": "Get schedule.", - "operationId": "GlobalSchedules_Get", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "$expand", - "in": "query", - "description": "Specify the $expand query. Example: 'properties($select=status)'", - "required": false, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "put": { - "tags": [ "GlobalSchedules" ], - "description": "Create or replace an existing schedule.", - "operationId": "GlobalSchedules_CreateOrUpdate", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/Schedule" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "201": { - "description": "Created", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "delete": { - "tags": [ "GlobalSchedules" ], - "description": "Delete schedule.", - "operationId": "GlobalSchedules_Delete", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "204": { "description": "No Content" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - }, - "patch": { - "tags": [ "GlobalSchedules" ], - "description": "Modify properties of schedules.", - "operationId": "GlobalSchedules_Update", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "schedule", - "in": "body", - "description": "A schedule.", - "required": true, - "schema": { "$ref": "#/definitions/ScheduleFragment" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { - "description": "OK", - "schema": { "$ref": "#/definitions/Schedule" } - }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute": { - "post": { - "tags": [ "GlobalSchedules" ], - "description": "Execute a schedule. This operation can take a while to complete.", - "operationId": "GlobalSchedules_Execute", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget": { - "post": { - "tags": [ "GlobalSchedules" ], - "description": "Updates a schedule's target resource Id. This operation can take a while to complete.", - "operationId": "GlobalSchedules_Retarget", - "parameters": [ - { "$ref": "#/parameters/subscriptionId" }, - { "$ref": "#/parameters/resourceGroupName" }, - { - "name": "name", - "in": "path", - "description": "The name of the schedule.", - "required": true, - "type": "string" - }, - { - "name": "retargetScheduleProperties", - "in": "body", - "description": "Properties for retargeting a virtual machine schedule.", - "required": true, - "schema": { "$ref": "#/definitions/RetargetScheduleProperties" } - }, - { "$ref": "#/parameters/api-version" } - ], - "responses": { - "200": { "description": "OK" }, - "202": { "description": "Accepted" }, - "default": { - "description": "BadRequest", - "schema": { "$ref": "#/definitions/CloudError" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ], - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "ApplicableSchedule": { - "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ApplicableScheduleProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ApplicableScheduleFragment": { - "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ApplicableSchedulePropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ApplicableScheduleProperties": { - "description": "Properties of a schedules applicable to a virtual machine.", - "type": "object", - "properties": { - "labVmsShutdown": { - "$ref": "#/definitions/Schedule", - "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." - }, - "labVmsStartup": { - "$ref": "#/definitions/Schedule", - "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." - } - } - }, - "ApplicableSchedulePropertiesFragment": { - "description": "Properties of a schedules applicable to a virtual machine.", - "type": "object", - "properties": { - "labVmsShutdown": { - "$ref": "#/definitions/ScheduleFragment", - "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." - }, - "labVmsStartup": { - "$ref": "#/definitions/ScheduleFragment", - "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." - } - } - }, - "ApplyArtifactsRequest": { - "description": "Request body for applying artifacts to a virtual machine.", - "type": "object", - "properties": { - "artifacts": { - "description": "The list of artifacts to apply.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactInstallProperties" } - } - } - }, - "ArmTemplate": { - "description": "An Azure Resource Manager template.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ArmTemplateProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ArmTemplateInfo": { - "description": "Information about a generated ARM template.", - "type": "object", - "properties": { - "template": { - "description": "The template's contents.", - "type": "object" - }, - "parameters": { - "description": "The parameters of the ARM template.", - "type": "object" - } - } - }, - "ArmTemplateParameterProperties": { - "description": "Properties of an Azure Resource Manager template parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the template parameter.", - "type": "string" - }, - "value": { - "description": "The value of the template parameter.", - "type": "string" - } - } - }, - "ArmTemplateProperties": { - "description": "Properties of an Azure Resource Manager template.", - "type": "object", - "properties": { - "displayName": { - "description": "The display name of the ARM template.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description of the ARM template.", - "type": "string", - "readOnly": true - }, - "publisher": { - "description": "The publisher of the ARM template.", - "type": "string", - "readOnly": true - }, - "icon": { - "description": "The URI to the icon of the ARM template.", - "type": "string", - "readOnly": true - }, - "contents": { - "description": "The contents of the ARM template.", - "type": "object", - "readOnly": true - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the armTemplate.", - "type": "string", - "readOnly": true - }, - "parametersValueFilesInfo": { - "description": "File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.", - "type": "array", - "items": { "$ref": "#/definitions/ParametersValueFileInfo" }, - "readOnly": true - } - } - }, - "Artifact": { - "description": "An artifact.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ArtifactProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ArtifactDeploymentStatusProperties": { - "description": "Properties of an artifact deployment.", - "type": "object", - "properties": { - "deploymentStatus": { - "description": "The deployment status of the artifact.", - "type": "string" - }, - "artifactsApplied": { - "format": "int32", - "description": "The total count of the artifacts that were successfully applied.", - "type": "integer" - }, - "totalArtifacts": { - "format": "int32", - "description": "The total count of the artifacts that were tentatively applied.", - "type": "integer" - } - } - }, - "ArtifactDeploymentStatusPropertiesFragment": { - "description": "Properties of an artifact deployment.", - "type": "object", - "properties": { - "deploymentStatus": { - "description": "The deployment status of the artifact.", - "type": "string" - }, - "artifactsApplied": { - "format": "int32", - "description": "The total count of the artifacts that were successfully applied.", - "type": "integer" - }, - "totalArtifacts": { - "format": "int32", - "description": "The total count of the artifacts that were tentatively applied.", - "type": "integer" - } - } - }, - "ArtifactInstallProperties": { - "description": "Properties of an artifact.", - "type": "object", - "properties": { - "artifactId": { - "description": "The artifact's identifier.", - "type": "string" - }, - "parameters": { - "description": "The parameters of the artifact.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactParameterProperties" } - }, - "status": { - "description": "The status of the artifact.", - "type": "string" - }, - "deploymentStatusMessage": { - "description": "The status message from the deployment.", - "type": "string" - }, - "vmExtensionStatusMessage": { - "description": "The status message from the virtual machine extension.", - "type": "string" - }, - "installTime": { - "format": "date-time", - "description": "The time that the artifact starts to install on the virtual machine.", - "type": "string" - } - } - }, - "ArtifactInstallPropertiesFragment": { - "description": "Properties of an artifact.", - "type": "object", - "properties": { - "artifactId": { - "description": "The artifact's identifier.", - "type": "string" - }, - "parameters": { - "description": "The parameters of the artifact.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactParameterPropertiesFragment" } - }, - "status": { - "description": "The status of the artifact.", - "type": "string" - }, - "deploymentStatusMessage": { - "description": "The status message from the deployment.", - "type": "string" - }, - "vmExtensionStatusMessage": { - "description": "The status message from the virtual machine extension.", - "type": "string" - }, - "installTime": { - "format": "date-time", - "description": "The time that the artifact starts to install on the virtual machine.", - "type": "string" - } - } - }, - "ArtifactParameterProperties": { - "description": "Properties of an artifact parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the artifact parameter.", - "type": "string" - }, - "value": { - "description": "The value of the artifact parameter.", - "type": "string" - } - } - }, - "ArtifactParameterPropertiesFragment": { - "description": "Properties of an artifact parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the artifact parameter.", - "type": "string" - }, - "value": { - "description": "The value of the artifact parameter.", - "type": "string" - } - } - }, - "ArtifactProperties": { - "description": "Properties of an artifact.", - "type": "object", - "properties": { - "title": { - "description": "The artifact's title.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The artifact's description.", - "type": "string", - "readOnly": true - }, - "publisher": { - "description": "The artifact's publisher.", - "type": "string", - "readOnly": true - }, - "filePath": { - "description": "The file path to the artifact.", - "type": "string", - "readOnly": true - }, - "icon": { - "description": "The URI to the artifact icon.", - "type": "string", - "readOnly": true - }, - "targetOsType": { - "description": "The artifact's target OS.", - "type": "string", - "readOnly": true - }, - "parameters": { - "description": "The artifact's parameters.", - "type": "object", - "readOnly": true - }, - "createdDate": { - "format": "date-time", - "description": "The artifact's creation date.", - "type": "string", - "readOnly": true - } - } - }, - "ArtifactSource": { - "description": "Properties of an artifact source.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ArtifactSourceProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ArtifactSourceFragment": { - "description": "Properties of an artifact source.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ArtifactSourcePropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ArtifactSourceProperties": { - "description": "Properties of an artifact source.", - "type": "object", - "properties": { - "displayName": { - "description": "The artifact source's display name.", - "type": "string" - }, - "uri": { - "description": "The artifact source's URI.", - "type": "string" - }, - "sourceType": { - "description": "The artifact source's type.", - "enum": [ "VsoGit", "GitHub" ], - "type": "string", - "x-ms-enum": { - "name": "SourceControlType", - "modelAsString": true - } - }, - "folderPath": { - "description": "The folder containing artifacts.", - "type": "string" - }, - "armTemplateFolderPath": { - "description": "The folder containing Azure Resource Manager templates.", - "type": "string" - }, - "branchRef": { - "description": "The artifact source's branch reference.", - "type": "string" - }, - "securityToken": { - "description": "The security token to authenticate to the artifact source.", - "type": "string" - }, - "status": { - "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "EnableStatus", - "modelAsString": true - } - }, - "createdDate": { - "format": "date-time", - "description": "The artifact source's creation date.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "ArtifactSourcePropertiesFragment": { - "description": "Properties of an artifact source.", - "type": "object", - "properties": { - "displayName": { - "description": "The artifact source's display name.", - "type": "string" - }, - "uri": { - "description": "The artifact source's URI.", - "type": "string" - }, - "sourceType": { - "description": "The artifact source's type.", - "enum": [ "VsoGit", "GitHub" ], - "type": "string", - "x-ms-enum": { - "name": "SourceControlType", - "modelAsString": true - } - }, - "folderPath": { - "description": "The folder containing artifacts.", - "type": "string" - }, - "armTemplateFolderPath": { - "description": "The folder containing Azure Resource Manager templates.", - "type": "string" - }, - "branchRef": { - "description": "The artifact source's branch reference.", - "type": "string" - }, - "securityToken": { - "description": "The security token to authenticate to the artifact source.", - "type": "string" - }, - "status": { - "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "EnableStatus", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "AttachDiskProperties": { - "description": "Properties of the disk to attach.", - "type": "object", - "properties": { - "leasedByLabVmId": { - "description": "The resource ID of the Lab virtual machine to which the disk is attached.", - "type": "string" - } - } - }, - "AttachNewDataDiskOptions": { - "description": "Properties to attach new disk to the Virtual Machine.", - "type": "object", - "properties": { - "diskSizeGiB": { - "format": "int32", - "description": "Size of the disk to be attached in GibiBytes.", - "type": "integer" - }, - "diskName": { - "description": "The name of the disk to be attached.", - "type": "string" - }, - "diskType": { - "description": "The storage type for the disk (i.e. Standard, Premium).", - "enum": [ "Standard", "Premium" ], - "type": "string", - "x-ms-enum": { - "name": "StorageType", - "modelAsString": true - } - } - } - }, - "BulkCreationParameters": { - "description": "Parameters for creating multiple virtual machines as a single action.", - "type": "object", - "properties": { - "instanceCount": { - "format": "int32", - "description": "The number of virtual machine instances to create.", - "type": "integer" - } - } - }, - "CloudError": { - "description": "Error from a REST request.", - "type": "object", - "properties": { "error": { "$ref": "#/definitions/CloudErrorBody" } }, - "x-ms-external": true - }, - "CloudErrorBody": { - "description": "Body of an error from a REST request.", - "type": "object", - "properties": { - "code": { "type": "string" }, - "message": { "type": "string" }, - "target": { "type": "string" }, - "details": { - "description": "Inner errors.", - "type": "array", - "items": { "$ref": "#/definitions/CloudErrorBody" } - } - }, - "x-ms-external": true - }, - "ComputeDataDisk": { - "description": "A data disks attached to a virtual machine.", - "type": "object", - "properties": { - "name": { - "description": "Gets data disk name.", - "type": "string" - }, - "diskUri": { - "description": "When backed by a blob, the URI of underlying blob.", - "type": "string" - }, - "managedDiskId": { - "description": "When backed by managed disk, this is the ID of the compute disk resource.", - "type": "string" - }, - "diskSizeGiB": { - "format": "int32", - "description": "Gets data disk size in GiB.", - "type": "integer" - } - } - }, - "ComputeDataDiskFragment": { - "description": "A data disks attached to a virtual machine.", - "type": "object", - "properties": { - "name": { - "description": "Gets data disk name.", - "type": "string" - }, - "diskUri": { - "description": "When backed by a blob, the URI of underlying blob.", - "type": "string" - }, - "managedDiskId": { - "description": "When backed by managed disk, this is the ID of the compute disk resource.", - "type": "string" - }, - "diskSizeGiB": { - "format": "int32", - "description": "Gets data disk size in GiB.", - "type": "integer" - } - } - }, - "ComputeVmInstanceViewStatus": { - "description": "Status information about a virtual machine.", - "type": "object", - "properties": { - "code": { - "description": "Gets the status Code.", - "type": "string" - }, - "displayStatus": { - "description": "Gets the short localizable label for the status.", - "type": "string" - }, - "message": { - "description": "Gets the message associated with the status.", - "type": "string" - } - } - }, - "ComputeVmInstanceViewStatusFragment": { - "description": "Status information about a virtual machine.", - "type": "object", - "properties": { - "code": { - "description": "Gets the status Code.", - "type": "string" - }, - "displayStatus": { - "description": "Gets the short localizable label for the status.", - "type": "string" - }, - "message": { - "description": "Gets the message associated with the status.", - "type": "string" - } - } - }, - "ComputeVmProperties": { - "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", - "type": "object", - "properties": { - "statuses": { - "description": "Gets the statuses of the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatus" } - }, - "osType": { - "description": "Gets the OS type of the virtual machine.", - "type": "string" - }, - "vmSize": { - "description": "Gets the size of the virtual machine.", - "type": "string" - }, - "networkInterfaceId": { - "description": "Gets the network interface ID of the virtual machine.", - "type": "string" - }, - "osDiskId": { - "description": "Gets OS disk blob uri for the virtual machine.", - "type": "string" - }, - "dataDiskIds": { - "description": "Gets data disks blob uri for the virtual machine.", - "type": "array", - "items": { "type": "string" } - }, - "dataDisks": { - "description": "Gets all data disks attached to the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ComputeDataDisk" } - } - } - }, - "ComputeVmPropertiesFragment": { - "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", - "type": "object", - "properties": { - "statuses": { - "description": "Gets the statuses of the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatusFragment" } - }, - "osType": { - "description": "Gets the OS type of the virtual machine.", - "type": "string" - }, - "vmSize": { - "description": "Gets the size of the virtual machine.", - "type": "string" - }, - "networkInterfaceId": { - "description": "Gets the network interface ID of the virtual machine.", - "type": "string" - }, - "osDiskId": { - "description": "Gets OS disk blob uri for the virtual machine.", - "type": "string" - }, - "dataDiskIds": { - "description": "Gets data disks blob uri for the virtual machine.", - "type": "array", - "items": { "type": "string" } - }, - "dataDisks": { - "description": "Gets all data disks attached to the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ComputeDataDiskFragment" } - } - } - }, - "CostThresholdProperties": { - "description": "Properties of a cost threshold item.", - "type": "object", - "properties": { - "thresholdId": { - "description": "The ID of the cost threshold item.", - "type": "string" - }, - "percentageThreshold": { - "$ref": "#/definitions/PercentageCostThresholdProperties", - "description": "The value of the percentage cost threshold." - }, - "displayOnChart": { - "description": "Indicates whether this threshold will be displayed on cost charts.", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "CostThresholdStatus", - "modelAsString": true - } - }, - "sendNotificationWhenExceeded": { - "description": "Indicates whether notifications will be sent when this threshold is exceeded.", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "CostThresholdStatus", - "modelAsString": true - } - }, - "notificationSent": { - "description": "Indicates the datetime when notifications were last sent for this threshold.", - "type": "string" - } - } - }, - "CustomImage": { - "description": "A custom image.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/CustomImageProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "CustomImageProperties": { - "description": "Properties of a custom image.", - "type": "object", - "properties": { - "vm": { - "$ref": "#/definitions/CustomImagePropertiesFromVm", - "description": "The virtual machine from which the image is to be created." - }, - "vhd": { - "$ref": "#/definitions/CustomImagePropertiesCustom", - "description": "The VHD from which the image is to be created." - }, - "description": { - "description": "The description of the custom image.", - "type": "string" - }, - "author": { - "description": "The author of the custom image.", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the custom image.", - "type": "string", - "readOnly": true - }, - "managedImageId": { - "description": "The Managed Image Id backing the custom image.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "CustomImagePropertiesCustom": { - "description": "Properties for creating a custom image from a VHD.", - "required": [ "osType" ], - "type": "object", - "properties": { - "imageName": { - "description": "The image name.", - "type": "string" - }, - "sysPrep": { - "description": "Indicates whether sysprep has been run on the VHD.", - "type": "boolean" - }, - "osType": { - "description": "The OS type of the custom image (i.e. Windows, Linux)", - "enum": [ "Windows", "Linux", "None" ], - "type": "string", - "x-ms-enum": { - "name": "CustomImageOsType", - "modelAsString": true - } - } - } - }, - "CustomImagePropertiesFromVm": { - "description": "Properties for creating a custom image from a virtual machine.", - "type": "object", - "properties": { - "sourceVmId": { - "description": "The source vm identifier.", - "type": "string" - }, - "windowsOsInfo": { - "$ref": "#/definitions/WindowsOsInfo", - "description": "The Windows OS information of the VM." - }, - "linuxOsInfo": { - "$ref": "#/definitions/LinuxOsInfo", - "description": "The Linux OS information of the VM." - } - } - }, - "DataDiskProperties": { - "description": "Request body for adding a new or existing data disk to a virtual machine.", - "type": "object", - "properties": { - "attachNewDataDiskOptions": { - "$ref": "#/definitions/AttachNewDataDiskOptions", - "description": "Specifies options to attach a new disk to the virtual machine." - }, - "existingLabDiskId": { - "description": "Specifies the existing lab disk id to attach to virtual machine.", - "type": "string" - }, - "hostCaching": { - "description": "Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).", - "enum": [ "None", "ReadOnly", "ReadWrite" ], - "type": "string", - "x-ms-enum": { - "name": "HostCachingOptions", - "modelAsString": true - } - } - } - }, - "DayDetails": { - "description": "Properties of a daily schedule.", - "type": "object", - "properties": { - "time": { - "description": "The time of day the schedule will occur.", - "type": "string" - } - } - }, - "DayDetailsFragment": { - "description": "Properties of a daily schedule.", - "type": "object", - "properties": { - "time": { - "description": "The time of day the schedule will occur.", - "type": "string" - } - } - }, - "DetachDataDiskProperties": { - "description": "Request body for detaching data disk from a virtual machine.", - "type": "object", - "properties": { - "existingLabDiskId": { - "description": "Specifies the disk resource ID to detach from virtual machine.", - "type": "string" - } - } - }, - "DetachDiskProperties": { - "description": "Properties of the disk to detach.", - "type": "object", - "properties": { - "leasedByLabVmId": { - "description": "The resource ID of the Lab VM to which the disk is attached.", - "type": "string" - } - } - }, - "Disk": { - "description": "A Disk.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/DiskProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "DiskProperties": { - "description": "Properties of a disk.", - "type": "object", - "properties": { - "diskType": { - "description": "The storage type for the disk (i.e. Standard, Premium).", - "enum": [ "Standard", "Premium" ], - "type": "string", - "x-ms-enum": { - "name": "StorageType", - "modelAsString": true - } - }, - "diskSizeGiB": { - "format": "int32", - "description": "The size of the disk in GibiBytes.", - "type": "integer" - }, - "leasedByLabVmId": { - "description": "The resource ID of the VM to which this disk is leased.", - "type": "string" - }, - "diskBlobName": { - "description": "When backed by a blob, the name of the VHD blob without extension.", - "type": "string" - }, - "diskUri": { - "description": "When backed by a blob, the URI of underlying blob.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the disk.", - "type": "string", - "readOnly": true - }, - "hostCaching": { - "description": "The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).", - "type": "string" - }, - "managedDiskId": { - "description": "When backed by managed disk, this is the ID of the compute disk resource.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "DtlEnvironment": { - "description": "An environment, which is essentially an ARM template deployment.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/EnvironmentProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "EnvironmentDeploymentProperties": { - "description": "Properties of an environment deployment.", - "type": "object", - "properties": { - "armTemplateId": { - "description": "The Azure Resource Manager template's identifier.", - "type": "string" - }, - "parameters": { - "description": "The parameters of the Azure Resource Manager template.", - "type": "array", - "items": { "$ref": "#/definitions/ArmTemplateParameterProperties" } - } - } - }, - "EnvironmentProperties": { - "description": "Properties of an environment.", - "type": "object", - "properties": { - "deploymentProperties": { - "$ref": "#/definitions/EnvironmentDeploymentProperties", - "description": "The deployment properties of the environment." - }, - "armTemplateDisplayName": { - "description": "The display name of the Azure Resource Manager template that produced the environment.", - "type": "string" - }, - "resourceGroupId": { - "description": "The identifier of the resource group containing the environment's resources.", - "type": "string", - "readOnly": true - }, - "createdByUser": { - "description": "The creator of the environment.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "EvaluatePoliciesProperties": { - "description": "Properties for evaluating a policy set.", - "type": "object", - "properties": { - "factName": { - "description": "The fact name.", - "type": "string" - }, - "factData": { - "description": "The fact data.", - "type": "string" - }, - "valueOffset": { - "description": "The value offset.", - "type": "string" - } - } - }, - "EvaluatePoliciesRequest": { - "description": "Request body for evaluating a policy set.", - "type": "object", - "properties": { - "policies": { - "description": "Policies to evaluate.", - "type": "array", - "items": { "$ref": "#/definitions/EvaluatePoliciesProperties" } - } - } - }, - "EvaluatePoliciesResponse": { - "description": "Response body for evaluating a policy set.", - "type": "object", - "properties": { - "results": { - "description": "Results of evaluating a policy set.", - "type": "array", - "items": { "$ref": "#/definitions/PolicySetResult" } - } - } - }, - "Event": { - "description": "An event to be notified for.", - "type": "object", - "properties": { - "eventName": { - "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", - "enum": [ "AutoShutdown", "Cost" ], - "type": "string", - "x-ms-enum": { - "name": "NotificationChannelEventType", - "modelAsString": true - } - } - } - }, - "EventFragment": { - "description": "An event to be notified for.", - "type": "object", - "properties": { - "eventName": { - "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", - "enum": [ "AutoShutdown", "Cost" ], - "type": "string", - "x-ms-enum": { - "name": "NotificationChannelEventType", - "modelAsString": true - } - } - } - }, - "ExportResourceUsageParameters": { - "description": "The parameters of the export operation.", - "type": "object", - "properties": { - "blobStorageAbsoluteSasUri": { - "description": "The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to.", - "type": "string" - }, - "usageStartDate": { - "format": "date-time", - "description": "The start time of the usage. If not provided, usage will be reported since the beginning of data collection.", - "type": "string" - } - } - }, - "ExternalSubnet": { - "description": "Subnet information as returned by the Microsoft.Network API.", - "type": "object", - "properties": { - "id": { - "description": "Gets or sets the identifier.", - "type": "string" - }, - "name": { - "description": "Gets or sets the name.", - "type": "string" - } - } - }, - "ExternalSubnetFragment": { - "description": "Subnet information as returned by the Microsoft.Network API.", - "type": "object", - "properties": { - "id": { - "description": "Gets or sets the identifier.", - "type": "string" - }, - "name": { - "description": "Gets or sets the name.", - "type": "string" - } - } - }, - "Formula": { - "description": "A formula for creating a VM, specifying an image base and other parameters", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/FormulaProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "FormulaProperties": { - "description": "Properties of a formula.", - "type": "object", - "properties": { - "description": { - "description": "The description of the formula.", - "type": "string" - }, - "author": { - "description": "The author of the formula.", - "type": "string" - }, - "osType": { - "description": "The OS type of the formula.", - "type": "string" - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the formula.", - "type": "string", - "readOnly": true - }, - "formulaContent": { - "$ref": "#/definitions/LabVirtualMachineCreationParameter", - "description": "The content of the formula." - }, - "vm": { - "$ref": "#/definitions/FormulaPropertiesFromVm", - "description": "Information about a VM from which a formula is to be created." - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "FormulaPropertiesFromVm": { - "description": "Information about a VM from which a formula is to be created.", - "type": "object", - "properties": { - "labVmId": { - "description": "The identifier of the VM from which a formula is to be created.", - "type": "string" - } - } - }, - "GalleryImage": { - "description": "A gallery image.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/GalleryImageProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "GalleryImageProperties": { - "description": "Properties of a gallery image.", - "type": "object", - "properties": { - "author": { - "description": "The author of the gallery image.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the gallery image.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "The description of the gallery image.", - "type": "string" - }, - "imageReference": { - "$ref": "#/definitions/GalleryImageReference", - "description": "The image reference of the gallery image." - }, - "icon": { - "description": "The icon of the gallery image.", - "type": "string" - }, - "enabled": { - "description": "Indicates whether this gallery image is enabled.", - "type": "boolean" - } - } - }, - "GalleryImageReference": { - "description": "The reference information for an Azure Marketplace image.", - "type": "object", - "properties": { - "offer": { - "description": "The offer of the gallery image.", - "type": "string" - }, - "publisher": { - "description": "The publisher of the gallery image.", - "type": "string" - }, - "sku": { - "description": "The SKU of the gallery image.", - "type": "string" - }, - "osType": { - "description": "The OS type of the gallery image.", - "type": "string" - }, - "version": { - "description": "The version of the gallery image.", - "type": "string" - } - } - }, - "GalleryImageReferenceFragment": { - "description": "The reference information for an Azure Marketplace image.", - "type": "object", - "properties": { - "offer": { - "description": "The offer of the gallery image.", - "type": "string" - }, - "publisher": { - "description": "The publisher of the gallery image.", - "type": "string" - }, - "sku": { - "description": "The SKU of the gallery image.", - "type": "string" - }, - "osType": { - "description": "The OS type of the gallery image.", - "type": "string" - }, - "version": { - "description": "The version of the gallery image.", - "type": "string" - } - } - }, - "GenerateArmTemplateRequest": { - "description": "Parameters for generating an ARM template for deploying artifacts.", - "type": "object", - "properties": { - "virtualMachineName": { - "description": "The resource name of the virtual machine.", - "type": "string" - }, - "parameters": { - "description": "The parameters of the ARM template.", - "type": "array", - "items": { "$ref": "#/definitions/ParameterInfo" } - }, - "location": { - "description": "The location of the virtual machine.", - "type": "string" - }, - "fileUploadOptions": { - "description": "Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value.", - "enum": [ "UploadFilesAndGenerateSasTokens", "None" ], - "type": "string", - "x-ms-enum": { - "name": "FileUploadOptions", - "modelAsString": true - } - } - } - }, - "GenerateUploadUriParameter": { - "description": "Properties for generating an upload URI.", - "type": "object", - "properties": { - "blobName": { - "description": "The blob name of the upload URI.", - "type": "string" - } - } - }, - "GenerateUploadUriResponse": { - "description": "Reponse body for generating an upload URI.", - "type": "object", - "properties": { - "uploadUri": { - "description": "The upload URI for the VHD.", - "type": "string" - } - } - }, - "HourDetails": { - "description": "Properties of an hourly schedule.", - "type": "object", - "properties": { - "minute": { - "format": "int32", - "description": "Minutes of the hour the schedule will run.", - "type": "integer" - } - } - }, - "HourDetailsFragment": { - "description": "Properties of an hourly schedule.", - "type": "object", - "properties": { - "minute": { - "format": "int32", - "description": "Minutes of the hour the schedule will run.", - "type": "integer" - } - } - }, - "IdentityProperties": { - "description": "Properties of a managed identity", - "type": "object", - "properties": { - "type": { - "description": "Managed identity.", - "type": "string" - }, - "principalId": { - "description": "The principal id of resource identity.", - "type": "string" - }, - "tenantId": { - "description": "The tenant identifier of resource.", - "type": "string" - }, - "clientSecretUrl": { - "description": "The client secret URL of the identity.", - "type": "string" - } - } - }, - "InboundNatRule": { - "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", - "type": "object", - "properties": { - "transportProtocol": { - "description": "The transport protocol for the endpoint.", - "enum": [ "Tcp", "Udp" ], - "type": "string", - "x-ms-enum": { - "name": "TransportProtocol", - "modelAsString": true - } - }, - "frontendPort": { - "format": "int32", - "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", - "type": "integer" - }, - "backendPort": { - "format": "int32", - "description": "The port to which the external traffic will be redirected.", - "type": "integer" - } - } - }, - "InboundNatRuleFragment": { - "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", - "type": "object", - "properties": { - "transportProtocol": { - "description": "The transport protocol for the endpoint.", - "enum": [ "Tcp", "Udp" ], - "type": "string", - "x-ms-enum": { - "name": "TransportProtocol", - "modelAsString": true - } - }, - "frontendPort": { - "format": "int32", - "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", - "type": "integer" - }, - "backendPort": { - "format": "int32", - "description": "The port to which the external traffic will be redirected.", - "type": "integer" - } - } - }, - "Lab": { - "description": "A lab.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/LabProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "LabCost": { - "description": "A cost item.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/LabCostProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "LabCostDetailsProperties": { - "description": "The properties of a lab cost item.", - "type": "object", - "properties": { - "date": { - "format": "date-time", - "description": "The date of the cost item.", - "type": "string" - }, - "cost": { - "format": "double", - "description": "The cost component of the cost item.", - "type": "number" - }, - "costType": { - "description": "The type of the cost.", - "enum": [ "Unavailable", "Reported", "Projected" ], - "type": "string", - "x-ms-enum": { - "name": "CostType", - "modelAsString": true - } - } - } - }, - "LabCostProperties": { - "description": "Properties of a cost item.", - "type": "object", - "properties": { - "targetCost": { - "$ref": "#/definitions/TargetCostProperties", - "description": "The target cost properties" - }, - "labCostSummary": { - "$ref": "#/definitions/LabCostSummaryProperties", - "description": "The lab cost summary component of the cost data.", - "readOnly": true - }, - "labCostDetails": { - "description": "The lab cost details component of the cost data.", - "type": "array", - "items": { "$ref": "#/definitions/LabCostDetailsProperties" }, - "readOnly": true - }, - "resourceCosts": { - "description": "The resource cost component of the cost data.", - "type": "array", - "items": { "$ref": "#/definitions/LabResourceCostProperties" }, - "readOnly": true - }, - "currencyCode": { - "description": "The currency code of the cost.", - "type": "string" - }, - "startDateTime": { - "format": "date-time", - "description": "The start time of the cost data.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "The end time of the cost data.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the cost.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LabCostSummaryProperties": { - "description": "The properties of the cost summary.", - "type": "object", - "properties": { - "estimatedLabCost": { - "format": "double", - "description": "The cost component of the cost item.", - "type": "number" - } - } - }, - "LabFragment": { - "description": "A lab.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/LabPropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "LabProperties": { - "description": "Properties of a lab.", - "type": "object", - "properties": { - "defaultStorageAccount": { - "description": "The lab's default storage account.", - "type": "string", - "readOnly": true - }, - "defaultPremiumStorageAccount": { - "description": "The lab's default premium storage account.", - "type": "string", - "readOnly": true - }, - "artifactsStorageAccount": { - "description": "The lab's artifact storage account.", - "type": "string", - "readOnly": true - }, - "premiumDataDiskStorageAccount": { - "description": "The lab's premium data disk storage account.", - "type": "string", - "readOnly": true - }, - "vaultName": { - "description": "The lab's Key vault.", - "type": "string", - "readOnly": true - }, - "labStorageType": { - "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", - "enum": [ "Standard", "Premium" ], - "type": "string", - "x-ms-enum": { - "name": "StorageType", - "modelAsString": true - } - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the lab.", - "type": "string", - "readOnly": true - }, - "premiumDataDisks": { - "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", - "enum": [ "Disabled", "Enabled" ], - "type": "string", - "x-ms-enum": { - "name": "PremiumDataDisk", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LabPropertiesFragment": { - "description": "Properties of a lab.", - "type": "object", - "properties": { - "labStorageType": { - "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", - "enum": [ "Standard", "Premium" ], - "type": "string", - "x-ms-enum": { - "name": "StorageType", - "modelAsString": true - } - }, - "premiumDataDisks": { - "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", - "enum": [ "Disabled", "Enabled" ], - "type": "string", - "x-ms-enum": { - "name": "PremiumDataDisk", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LabResourceCostProperties": { - "description": "The properties of a resource cost item.", - "type": "object", - "properties": { - "resourcename": { - "description": "The name of the resource.", - "type": "string" - }, - "resourceUId": { - "description": "The unique identifier of the resource.", - "type": "string" - }, - "resourceCost": { - "format": "double", - "description": "The cost component of the resource cost item.", - "type": "number" - }, - "resourceType": { - "description": "The logical resource type (ex. virtualmachine, storageaccount)", - "type": "string" - }, - "resourceOwner": { - "description": "The owner of the resource (ex. janedoe@microsoft.com)", - "type": "string" - }, - "resourcePricingTier": { - "description": "The category of the resource (ex. Premium_LRS, Standard_DS1)", - "type": "string" - }, - "resourceStatus": { - "description": "The status of the resource (ex. Active)", - "type": "string" - }, - "resourceId": { - "description": "The ID of the resource", - "type": "string" - }, - "externalResourceId": { - "description": "The ID of the external resource", - "type": "string" - } - } - }, - "LabVhd": { - "description": "Properties of a VHD in the lab.", - "type": "object", - "properties": { - "id": { - "description": "The URI to the VHD.", - "type": "string" - } - } - }, - "LabVirtualMachine": { - "description": "A virtual machine.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/LabVirtualMachineProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "LabVirtualMachineCreationParameter": { - "description": "Properties for creating a virtual machine.", - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/LabVirtualMachineCreationParameterProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - }, - "name": { - "description": "The name of the virtual machine or environment", - "type": "string" - }, - "location": { - "description": "The location of the new virtual machine or environment", - "type": "string" - }, - "tags": { - "description": "The tags of the resource.", - "type": "object", - "additionalProperties": { "type": "string" } - } - } - }, - "LabVirtualMachineCreationParameterProperties": { - "description": "Properties for virtual machine creation.", - "type": "object", - "properties": { - "bulkCreationParameters": { - "$ref": "#/definitions/BulkCreationParameters", - "description": "The number of virtual machine instances to create." - }, - "notes": { - "description": "The notes of the virtual machine.", - "type": "string" - }, - "ownerObjectId": { - "description": "The object identifier of the owner of the virtual machine.", - "type": "string" - }, - "ownerUserPrincipalName": { - "description": "The user principal name of the virtual machine owner.", - "type": "string" - }, - "createdByUserId": { - "description": "The object identifier of the creator of the virtual machine.", - "type": "string" - }, - "createdByUser": { - "description": "The email address of creator of the virtual machine.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the virtual machine.", - "type": "string" - }, - "customImageId": { - "description": "The custom image identifier of the virtual machine.", - "type": "string" - }, - "osType": { - "description": "The OS type of the virtual machine.", - "type": "string" - }, - "size": { - "description": "The size of the virtual machine.", - "type": "string" - }, - "userName": { - "description": "The user name of the virtual machine.", - "type": "string" - }, - "password": { - "description": "The password of the virtual machine administrator.", - "type": "string" - }, - "sshKey": { - "description": "The SSH key of the virtual machine administrator.", - "type": "string" - }, - "isAuthenticationWithSshKey": { - "description": "Indicates whether this virtual machine uses an SSH key for authentication.", - "type": "boolean" - }, - "fqdn": { - "description": "The fully-qualified domain name of the virtual machine.", - "type": "string" - }, - "labSubnetName": { - "description": "The lab subnet name of the virtual machine.", - "type": "string" - }, - "labVirtualNetworkId": { - "description": "The lab virtual network identifier of the virtual machine.", - "type": "string" - }, - "disallowPublicIpAddress": { - "description": "Indicates whether the virtual machine is to be created without a public IP address.", - "type": "boolean" - }, - "artifacts": { - "description": "The artifacts to be installed on the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactInstallProperties" } - }, - "artifactDeploymentStatus": { - "$ref": "#/definitions/ArtifactDeploymentStatusProperties", - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "$ref": "#/definitions/GalleryImageReference", - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "computeVm": { - "$ref": "#/definitions/ComputeVmProperties", - "description": "The compute virtual machine properties." - }, - "networkInterface": { - "$ref": "#/definitions/NetworkInterfaceProperties", - "description": "The network interface properties." - }, - "applicableSchedule": { - "$ref": "#/definitions/ApplicableSchedule", - "description": "The applicable schedule for the virtual machine." - }, - "expirationDate": { - "format": "date-time", - "description": "The expiration date for VM.", - "type": "string" - }, - "allowClaim": { - "description": "Indicates whether another user can take ownership of the virtual machine", - "type": "boolean" - }, - "storageType": { - "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", - "type": "string" - }, - "virtualMachineCreationSource": { - "description": "Tells source of creation of lab virtual machine. Output property only.", - "enum": [ "FromCustomImage", "FromGalleryImage" ], - "type": "string", - "x-ms-enum": { - "name": "VirtualMachineCreationSource", - "modelAsString": true - } - }, - "environmentId": { - "description": "The resource ID of the environment that contains this virtual machine, if any.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LabVirtualMachineFragment": { - "description": "A virtual machine.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/LabVirtualMachinePropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "LabVirtualMachineProperties": { - "description": "Properties of a virtual machine.", - "type": "object", - "properties": { - "notes": { - "description": "The notes of the virtual machine.", - "type": "string" - }, - "ownerObjectId": { - "description": "The object identifier of the owner of the virtual machine.", - "type": "string" - }, - "ownerUserPrincipalName": { - "description": "The user principal name of the virtual machine owner.", - "type": "string" - }, - "createdByUserId": { - "description": "The object identifier of the creator of the virtual machine.", - "type": "string" - }, - "createdByUser": { - "description": "The email address of creator of the virtual machine.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the virtual machine.", - "type": "string" - }, - "computeId": { - "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", - "type": "string", - "readOnly": true - }, - "customImageId": { - "description": "The custom image identifier of the virtual machine.", - "type": "string" - }, - "osType": { - "description": "The OS type of the virtual machine.", - "type": "string" - }, - "size": { - "description": "The size of the virtual machine.", - "type": "string" - }, - "userName": { - "description": "The user name of the virtual machine.", - "type": "string" - }, - "password": { - "description": "The password of the virtual machine administrator.", - "type": "string" - }, - "sshKey": { - "description": "The SSH key of the virtual machine administrator.", - "type": "string" - }, - "isAuthenticationWithSshKey": { - "description": "Indicates whether this virtual machine uses an SSH key for authentication.", - "type": "boolean" - }, - "fqdn": { - "description": "The fully-qualified domain name of the virtual machine.", - "type": "string" - }, - "labSubnetName": { - "description": "The lab subnet name of the virtual machine.", - "type": "string" - }, - "labVirtualNetworkId": { - "description": "The lab virtual network identifier of the virtual machine.", - "type": "string" - }, - "disallowPublicIpAddress": { - "description": "Indicates whether the virtual machine is to be created without a public IP address.", - "type": "boolean" - }, - "artifacts": { - "description": "The artifacts to be installed on the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactInstallProperties" } - }, - "artifactDeploymentStatus": { - "$ref": "#/definitions/ArtifactDeploymentStatusProperties", - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "$ref": "#/definitions/GalleryImageReference", - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "computeVm": { - "$ref": "#/definitions/ComputeVmProperties", - "description": "The compute virtual machine properties." - }, - "networkInterface": { - "$ref": "#/definitions/NetworkInterfaceProperties", - "description": "The network interface properties." - }, - "applicableSchedule": { - "$ref": "#/definitions/ApplicableSchedule", - "description": "The applicable schedule for the virtual machine." - }, - "expirationDate": { - "format": "date-time", - "description": "The expiration date for VM.", - "type": "string" - }, - "allowClaim": { - "description": "Indicates whether another user can take ownership of the virtual machine", - "type": "boolean" - }, - "storageType": { - "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", - "type": "string" - }, - "virtualMachineCreationSource": { - "description": "Tells source of creation of lab virtual machine. Output property only.", - "enum": [ "FromCustomImage", "FromGalleryImage" ], - "type": "string", - "x-ms-enum": { - "name": "VirtualMachineCreationSource", - "modelAsString": true - } - }, - "environmentId": { - "description": "The resource ID of the environment that contains this virtual machine, if any.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LabVirtualMachinePropertiesFragment": { - "description": "Properties of a virtual machine.", - "type": "object", - "properties": { - "notes": { - "description": "The notes of the virtual machine.", - "type": "string" - }, - "ownerObjectId": { - "description": "The object identifier of the owner of the virtual machine.", - "type": "string" - }, - "ownerUserPrincipalName": { - "description": "The user principal name of the virtual machine owner.", - "type": "string" - }, - "createdByUserId": { - "description": "The object identifier of the creator of the virtual machine.", - "type": "string" - }, - "createdByUser": { - "description": "The email address of creator of the virtual machine.", - "type": "string" - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the virtual machine.", - "type": "string" - }, - "customImageId": { - "description": "The custom image identifier of the virtual machine.", - "type": "string" - }, - "osType": { - "description": "The OS type of the virtual machine.", - "type": "string" - }, - "size": { - "description": "The size of the virtual machine.", - "type": "string" - }, - "userName": { - "description": "The user name of the virtual machine.", - "type": "string" - }, - "password": { - "description": "The password of the virtual machine administrator.", - "type": "string" - }, - "sshKey": { - "description": "The SSH key of the virtual machine administrator.", - "type": "string" - }, - "isAuthenticationWithSshKey": { - "description": "Indicates whether this virtual machine uses an SSH key for authentication.", - "type": "boolean" - }, - "fqdn": { - "description": "The fully-qualified domain name of the virtual machine.", - "type": "string" - }, - "labSubnetName": { - "description": "The lab subnet name of the virtual machine.", - "type": "string" - }, - "labVirtualNetworkId": { - "description": "The lab virtual network identifier of the virtual machine.", - "type": "string" - }, - "disallowPublicIpAddress": { - "description": "Indicates whether the virtual machine is to be created without a public IP address.", - "type": "boolean" - }, - "artifacts": { - "description": "The artifacts to be installed on the virtual machine.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactInstallPropertiesFragment" } - }, - "artifactDeploymentStatus": { - "$ref": "#/definitions/ArtifactDeploymentStatusPropertiesFragment", - "description": "The artifact deployment status for the virtual machine." - }, - "galleryImageReference": { - "$ref": "#/definitions/GalleryImageReferenceFragment", - "description": "The Microsoft Azure Marketplace image reference of the virtual machine." - }, - "computeVm": { - "$ref": "#/definitions/ComputeVmPropertiesFragment", - "description": "The compute virtual machine properties." - }, - "networkInterface": { - "$ref": "#/definitions/NetworkInterfacePropertiesFragment", - "description": "The network interface properties." - }, - "applicableSchedule": { - "$ref": "#/definitions/ApplicableScheduleFragment", - "description": "The applicable schedule for the virtual machine." - }, - "expirationDate": { - "format": "date-time", - "description": "The expiration date for VM.", - "type": "string" - }, - "allowClaim": { - "description": "Indicates whether another user can take ownership of the virtual machine", - "type": "boolean" - }, - "storageType": { - "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", - "type": "string" - }, - "virtualMachineCreationSource": { - "description": "Tells source of creation of lab virtual machine. Output property only.", - "enum": [ "FromCustomImage", "FromGalleryImage" ], - "type": "string", - "x-ms-enum": { - "name": "VirtualMachineCreationSource", - "modelAsString": true - } - }, - "environmentId": { - "description": "The resource ID of the environment that contains this virtual machine, if any.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "LinuxOsInfo": { - "description": "Information about a Linux OS.", - "type": "object", - "properties": { - "linuxOsState": { - "description": "The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).", - "enum": [ "NonDeprovisioned", "DeprovisionRequested", "DeprovisionApplied" ], - "type": "string", - "x-ms-enum": { - "name": "LinuxOsState", - "modelAsString": true - } - } - } - }, - "NetworkInterfaceProperties": { - "description": "Properties of a network interface.", - "type": "object", - "properties": { - "virtualNetworkId": { - "description": "The resource ID of the virtual network.", - "type": "string" - }, - "subnetId": { - "description": "The resource ID of the sub net.", - "type": "string" - }, - "publicIpAddressId": { - "description": "The resource ID of the public IP address.", - "type": "string" - }, - "publicIpAddress": { - "description": "The public IP address.", - "type": "string" - }, - "privateIpAddress": { - "description": "The private IP address.", - "type": "string" - }, - "dnsName": { - "description": "The DNS name.", - "type": "string" - }, - "rdpAuthority": { - "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", - "type": "string" - }, - "sshAuthority": { - "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", - "type": "string" - }, - "sharedPublicIpAddressConfiguration": { - "$ref": "#/definitions/SharedPublicIpAddressConfiguration", - "description": "The configuration for sharing a public IP address across multiple virtual machines." - } - } - }, - "NetworkInterfacePropertiesFragment": { - "description": "Properties of a network interface.", - "type": "object", - "properties": { - "virtualNetworkId": { - "description": "The resource ID of the virtual network.", - "type": "string" - }, - "subnetId": { - "description": "The resource ID of the sub net.", - "type": "string" - }, - "publicIpAddressId": { - "description": "The resource ID of the public IP address.", - "type": "string" - }, - "publicIpAddress": { - "description": "The public IP address.", - "type": "string" - }, - "privateIpAddress": { - "description": "The private IP address.", - "type": "string" - }, - "dnsName": { - "description": "The DNS name.", - "type": "string" - }, - "rdpAuthority": { - "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", - "type": "string" - }, - "sshAuthority": { - "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", - "type": "string" - }, - "sharedPublicIpAddressConfiguration": { - "$ref": "#/definitions/SharedPublicIpAddressConfigurationFragment", - "description": "The configuration for sharing a public IP address across multiple virtual machines." - } - } - }, - "NotificationChannel": { - "description": "A notification.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/NotificationChannelProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "NotificationChannelFragment": { - "description": "A notification.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/NotificationChannelPropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "NotificationChannelProperties": { - "description": "Properties of a schedule.", - "type": "object", - "properties": { - "webHookUrl": { - "description": "The webhook URL to send notifications to.", - "type": "string" - }, - "description": { - "description": "Description of notification.", - "type": "string" - }, - "events": { - "description": "The list of event for which this notification is enabled.", - "type": "array", - "items": { "$ref": "#/definitions/Event" } - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the notification channel.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "NotificationChannelPropertiesFragment": { - "description": "Properties of a schedule.", - "type": "object", - "properties": { - "webHookUrl": { - "description": "The webhook URL to send notifications to.", - "type": "string" - }, - "description": { - "description": "Description of notification.", - "type": "string" - }, - "events": { - "description": "The list of event for which this notification is enabled.", - "type": "array", - "items": { "$ref": "#/definitions/EventFragment" } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "NotificationSettings": { - "description": "Notification settings for a schedule.", - "type": "object", - "properties": { - "status": { - "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", - "enum": [ "Disabled", "Enabled" ], - "type": "string", - "x-ms-enum": { - "name": "NotificationStatus", - "modelAsString": true - } - }, - "timeInMinutes": { - "format": "int32", - "description": "Time in minutes before event at which notification will be sent.", - "type": "integer" - }, - "webhookUrl": { - "description": "The webhook URL to which the notification will be sent.", - "type": "string" - } - } - }, - "NotificationSettingsFragment": { - "description": "Notification settings for a schedule.", - "type": "object", - "properties": { - "status": { - "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", - "enum": [ "Disabled", "Enabled" ], - "type": "string", - "x-ms-enum": { - "name": "NotificationStatus", - "modelAsString": true - } - }, - "timeInMinutes": { - "format": "int32", - "description": "Time in minutes before event at which notification will be sent.", - "type": "integer" - }, - "webhookUrl": { - "description": "The webhook URL to which the notification will be sent.", - "type": "string" - } - } - }, - "NotifyParameters": { - "description": "Properties for generating a Notification.", - "type": "object", - "properties": { - "eventName": { - "description": "The type of event (i.e. AutoShutdown, Cost)", - "enum": [ "AutoShutdown", "Cost" ], - "type": "string", - "x-ms-enum": { - "name": "NotificationChannelEventType", - "modelAsString": true - } - }, - "jsonPayload": { - "description": "Properties for the notification in json format.", - "type": "string" - } - } - }, - "OperationError": { - "description": "Error details for the operation in case of a failure.", - "type": "object", - "properties": { - "code": { - "description": "The error code of the operation error.", - "type": "string" - }, - "message": { - "description": "The error message of the operation error.", - "type": "string" - } - } - }, - "OperationMetadata": { - "description": "The REST API operation supported by DevTestLab ResourceProvider.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationMetadataDisplay", - "description": "The object that describes the operations" - } - } - }, - "OperationMetadataDisplay": { - "description": "The object that describes the operations", - "type": "object", - "properties": { - "provider": { - "description": "Friendly name of the resource provider", - "type": "string" - }, - "resource": { - "description": "Resource type on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Operation type: read, write, delete, listKeys/action, etc.", - "type": "string" - }, - "description": { - "description": "Friendly name of the operation", - "type": "string" - } - } - }, - "OperationResult": { - "description": "An Operation Result", - "type": "object", - "properties": { - "status": { - "description": "The operation status.", - "type": "string" - }, - "statusCode": { - "description": "The status code for the operation.", - "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "MovedPermanently", "Redirect", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], - "type": "string", - "x-ms-enum": { - "name": "HttpStatusCode", - "modelAsString": true - } - }, - "error": { - "$ref": "#/definitions/OperationError", - "description": "Error details for the operation in case of a failure." - } - } - }, - "ParameterInfo": { - "description": "Information about an artifact's parameter.", - "type": "object", - "properties": { - "name": { - "description": "The name of the artifact parameter.", - "type": "string" - }, - "value": { - "description": "The value of the artifact parameter.", - "type": "string" - } - } - }, - "ParametersValueFileInfo": { - "description": "A file containing a set of parameter values for an ARM template.", - "type": "object", - "properties": { - "fileName": { - "description": "File name.", - "type": "string" - }, - "parametersValueInfo": { - "description": "Contents of the file.", - "type": "object" - } - } - }, - "PercentageCostThresholdProperties": { - "description": "Properties of a percentage cost threshold.", - "type": "object", - "properties": { - "thresholdValue": { - "format": "double", - "description": "The cost threshold value.", - "type": "number" - } - } - }, - "Policy": { - "description": "A Policy.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/PolicyProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "PolicyFragment": { - "description": "A Policy.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/PolicyPropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "PolicyProperties": { - "description": "Properties of a Policy.", - "type": "object", - "properties": { - "description": { - "description": "The description of the policy.", - "type": "string" - }, - "status": { - "description": "The status of the policy.", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyStatus", - "modelAsString": true - } - }, - "factName": { - "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", - "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyFactName", - "modelAsString": true - } - }, - "factData": { - "description": "The fact data of the policy.", - "type": "string" - }, - "threshold": { - "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", - "type": "string" - }, - "evaluatorType": { - "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", - "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyEvaluatorType", - "modelAsString": true - } - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the policy.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "PolicyPropertiesFragment": { - "description": "Properties of a Policy.", - "type": "object", - "properties": { - "description": { - "description": "The description of the policy.", - "type": "string" - }, - "status": { - "description": "The status of the policy.", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyStatus", - "modelAsString": true - } - }, - "factName": { - "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", - "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyFactName", - "modelAsString": true - } - }, - "factData": { - "description": "The fact data of the policy.", - "type": "string" - }, - "threshold": { - "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", - "type": "string" - }, - "evaluatorType": { - "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", - "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], - "type": "string", - "x-ms-enum": { - "name": "PolicyEvaluatorType", - "modelAsString": true - } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "PolicySetResult": { - "description": "Result of a policy set evaluation.", - "type": "object", - "properties": { - "hasError": { - "description": "A value indicating whether this policy set evaluation has discovered violations.", - "type": "boolean" - }, - "policyViolations": { - "description": "The list of policy violations.", - "type": "array", - "items": { "$ref": "#/definitions/PolicyViolation" } - } - } - }, - "PolicyViolation": { - "description": "Policy violation.", - "type": "object", - "properties": { - "code": { - "description": "The code of the policy violation.", - "type": "string" - }, - "message": { - "description": "The message of the policy violation.", - "type": "string" - } - } - }, - "Port": { - "description": "Properties of a network port.", - "type": "object", - "properties": { - "transportProtocol": { - "description": "Protocol type of the port.", - "enum": [ "Tcp", "Udp" ], - "type": "string", - "x-ms-enum": { - "name": "TransportProtocol", - "modelAsString": true - } - }, - "backendPort": { - "format": "int32", - "description": "Backend port of the target virtual machine.", - "type": "integer" - } - } - }, - "PortFragment": { - "description": "Properties of a network port.", - "type": "object", - "properties": { - "transportProtocol": { - "description": "Protocol type of the port.", - "enum": [ "Tcp", "Udp" ], - "type": "string", - "x-ms-enum": { - "name": "TransportProtocol", - "modelAsString": true - } - }, - "backendPort": { - "format": "int32", - "description": "Backend port of the target virtual machine.", - "type": "integer" - } - } - }, - "ProviderOperationResult": { - "description": "Result of the request to list REST API operations", - "type": "object", - "properties": { - "value": { - "description": "List of operations supported by the resource provider.", - "type": "array", - "items": { "$ref": "#/definitions/OperationMetadata" } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "An Azure resource.", - "type": "object", - "properties": { - "id": { - "description": "The identifier of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true - }, - "location": { - "description": "The location of the resource.", - "type": "string" - }, - "tags": { - "description": "The tags of the resource.", - "type": "object", - "additionalProperties": { "type": "string" } - } - }, - "x-ms-azure-resource": true - }, - "ResponseWithContinuation[ArmTemplate]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/ArmTemplate" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Artifact]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Artifact" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[ArtifactSource]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/ArtifactSource" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[CustomImage]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/CustomImage" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Disk]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Disk" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[DtlEnvironment]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/DtlEnvironment" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Formula]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Formula" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[GalleryImage]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/GalleryImage" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Lab]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Lab" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[LabVhd]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/LabVhd" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[LabVirtualMachine]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/LabVirtualMachine" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[NotificationChannel]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/NotificationChannel" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Policy]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Policy" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Schedule]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Schedule" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[Secret]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/Secret" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[ServiceRunner]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/ServiceRunner" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[User]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/User" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "ResponseWithContinuation[VirtualNetwork]": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Results of the list operation.", - "type": "array", - "items": { "$ref": "#/definitions/VirtualNetwork" } - }, - "nextLink": { - "description": "Link for next set of results.", - "type": "string" - } - } - }, - "RetargetScheduleProperties": { - "description": "Properties for retargeting a virtual machine schedule.", - "type": "object", - "properties": { - "currentResourceId": { - "description": "The resource Id of the virtual machine on which the schedule operates", - "type": "string" - }, - "targetResourceId": { - "description": "The resource Id of the virtual machine that the schedule should be retargeted to", - "type": "string" - } - } - }, - "Schedule": { - "description": "A schedule.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/ScheduleProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ScheduleFragment": { - "description": "A schedule.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/SchedulePropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "ScheduleProperties": { - "description": "Properties of a schedule.", - "type": "object", - "properties": { - "status": { - "description": "The status of the schedule (i.e. Enabled, Disabled)", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "EnableStatus", - "modelAsString": true - } - }, - "taskType": { - "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", - "type": "string" - }, - "weeklyRecurrence": { - "$ref": "#/definitions/WeekDetails", - "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." - }, - "dailyRecurrence": { - "$ref": "#/definitions/DayDetails", - "description": "If the schedule will occur once each day of the week, specify the daily recurrence." - }, - "hourlyRecurrence": { - "$ref": "#/definitions/HourDetails", - "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." - }, - "timeZoneId": { - "description": "The time zone ID (e.g. Pacific Standard time).", - "type": "string" - }, - "notificationSettings": { - "$ref": "#/definitions/NotificationSettings", - "description": "Notification settings." - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the schedule.", - "type": "string", - "readOnly": true - }, - "targetResourceId": { - "description": "The resource ID to which the schedule belongs", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "SchedulePropertiesFragment": { - "description": "Properties of a schedule.", - "type": "object", - "properties": { - "status": { - "description": "The status of the schedule (i.e. Enabled, Disabled)", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "EnableStatus", - "modelAsString": true - } - }, - "taskType": { - "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", - "type": "string" - }, - "weeklyRecurrence": { - "$ref": "#/definitions/WeekDetailsFragment", - "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." - }, - "dailyRecurrence": { - "$ref": "#/definitions/DayDetailsFragment", - "description": "If the schedule will occur once each day of the week, specify the daily recurrence." - }, - "hourlyRecurrence": { - "$ref": "#/definitions/HourDetailsFragment", - "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." - }, - "timeZoneId": { - "description": "The time zone ID (e.g. Pacific Standard time).", - "type": "string" - }, - "notificationSettings": { - "$ref": "#/definitions/NotificationSettingsFragment", - "description": "Notification settings." - }, - "targetResourceId": { - "description": "The resource ID to which the schedule belongs", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "Secret": { - "description": "A secret.", - "required": [ "properties" ], - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/SecretProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "SecretProperties": { - "description": "Properties of a secret.", - "type": "object", - "properties": { - "value": { - "description": "The value of the secret for secret creation.", - "type": "string" - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "ServiceRunner": { - "description": "A container for a managed identity to execute DevTest lab services.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "identity": { - "$ref": "#/definitions/IdentityProperties", - "description": "The identity of the resource." - } - } - }, - "SharedPublicIpAddressConfiguration": { - "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", - "type": "object", - "properties": { - "inboundNatRules": { - "description": "The incoming NAT rules", - "type": "array", - "items": { "$ref": "#/definitions/InboundNatRule" } - } - } - }, - "SharedPublicIpAddressConfigurationFragment": { - "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", - "type": "object", - "properties": { - "inboundNatRules": { - "description": "The incoming NAT rules", - "type": "array", - "items": { "$ref": "#/definitions/InboundNatRuleFragment" } - } - } - }, - "ShutdownNotificationContent": { - "description": "The contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown.", - "type": "object", - "properties": { - "skipUrl": { - "description": "The URL to skip auto-shutdown.", - "type": "string" - }, - "delayUrl60": { - "description": "The URL to delay shutdown by 60 minutes.", - "type": "string" - }, - "delayUrl120": { - "description": "The URL to delay shutdown by 2 hours.", - "type": "string" - }, - "vmName": { - "description": "The virtual machine to be shut down.", - "type": "string" - }, - "guid": { - "description": "The GUID for the virtual machine to be shut down.", - "type": "string" - }, - "owner": { - "description": "The owner of the virtual machine.", - "type": "string" - }, - "eventType": { - "description": "The event for which a notification will be sent.", - "type": "string" - }, - "text": { - "description": "The text for the notification.", - "type": "string" - }, - "subscriptionId": { - "description": "The subscription ID for the schedule.", - "type": "string" - }, - "resourceGroupName": { - "description": "The resource group name for the schedule.", - "type": "string" - }, - "labName": { - "description": "The lab for the schedule.", - "type": "string" - } - } - }, - "Subnet": { - "description": "Subnet information.", - "type": "object", - "properties": { - "resourceId": { - "description": "The resource ID of the subnet.", - "type": "string" - }, - "labSubnetName": { - "description": "The name of the subnet as seen in the lab.", - "type": "string" - }, - "allowPublicIp": { - "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - } - } - }, - "SubnetFragment": { - "description": "Subnet information.", - "type": "object", - "properties": { - "resourceId": { - "description": "The resource ID of the subnet.", - "type": "string" - }, - "labSubnetName": { - "description": "The name of the subnet as seen in the lab.", - "type": "string" - }, - "allowPublicIp": { - "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - } - } - }, - "SubnetOverride": { - "description": "Property overrides on a subnet of a virtual network.", - "type": "object", - "properties": { - "resourceId": { - "description": "The resource ID of the subnet.", - "type": "string" - }, - "labSubnetName": { - "description": "The name given to the subnet within the lab.", - "type": "string" - }, - "useInVmCreationPermission": { - "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - }, - "usePublicIpAddressPermission": { - "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - }, - "sharedPublicIpAddressConfiguration": { - "$ref": "#/definitions/SubnetSharedPublicIpAddressConfiguration", - "description": "Properties that virtual machines on this subnet will share." - }, - "virtualNetworkPoolName": { - "description": "The virtual network pool associated with this subnet.", - "type": "string" - } - } - }, - "SubnetOverrideFragment": { - "description": "Property overrides on a subnet of a virtual network.", - "type": "object", - "properties": { - "resourceId": { - "description": "The resource ID of the subnet.", - "type": "string" - }, - "labSubnetName": { - "description": "The name given to the subnet within the lab.", - "type": "string" - }, - "useInVmCreationPermission": { - "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - }, - "usePublicIpAddressPermission": { - "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", - "enum": [ "Default", "Deny", "Allow" ], - "type": "string", - "x-ms-enum": { - "name": "UsagePermissionType", - "modelAsString": true - } - }, - "sharedPublicIpAddressConfiguration": { - "$ref": "#/definitions/SubnetSharedPublicIpAddressConfigurationFragment", - "description": "Properties that virtual machines on this subnet will share." - }, - "virtualNetworkPoolName": { - "description": "The virtual network pool associated with this subnet.", - "type": "string" - } - } - }, - "SubnetSharedPublicIpAddressConfiguration": { - "description": "Configuration for public IP address sharing.", - "type": "object", - "properties": { - "allowedPorts": { - "description": "Backend ports that virtual machines on this subnet are allowed to expose", - "type": "array", - "items": { "$ref": "#/definitions/Port" } - } - } - }, - "SubnetSharedPublicIpAddressConfigurationFragment": { - "description": "Configuration for public IP address sharing.", - "type": "object", - "properties": { - "allowedPorts": { - "description": "Backend ports that virtual machines on this subnet are allowed to expose", - "type": "array", - "items": { "$ref": "#/definitions/PortFragment" } - } - } - }, - "TargetCostProperties": { - "description": "Properties of a cost target.", - "type": "object", - "properties": { - "status": { - "description": "Target cost status", - "enum": [ "Enabled", "Disabled" ], - "type": "string", - "x-ms-enum": { - "name": "TargetCostStatus", - "modelAsString": true - } - }, - "target": { - "format": "int32", - "description": "Lab target cost", - "type": "integer" - }, - "costThresholds": { - "description": "Cost thresholds.", - "type": "array", - "items": { "$ref": "#/definitions/CostThresholdProperties" } - }, - "cycleStartDateTime": { - "format": "date-time", - "description": "Reporting cycle start date.", - "type": "string" - }, - "cycleEndDateTime": { - "format": "date-time", - "description": "Reporting cycle end date.", - "type": "string" - }, - "cycleType": { - "description": "Reporting cycle type.", - "enum": [ "CalendarMonth", "Custom" ], - "type": "string", - "x-ms-enum": { - "name": "ReportingCycleType", - "modelAsString": true - } - } - } - }, - "User": { - "description": "Profile of a lab user.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/UserProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "UserFragment": { - "description": "Profile of a lab user.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/UserPropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "UserIdentity": { - "description": "Identity attributes of a lab user.", - "type": "object", - "properties": { - "principalName": { - "description": "Set to the principal name / UPN of the client JWT making the request.", - "type": "string" - }, - "principalId": { - "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", - "type": "string" - }, - "tenantId": { - "description": "Set to the tenant ID of the client JWT making the request.", - "type": "string" - }, - "objectId": { - "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", - "type": "string" - }, - "appId": { - "description": "Set to the app Id of the client JWT making the request.", - "type": "string" - } - } - }, - "UserIdentityFragment": { - "description": "Identity attributes of a lab user.", - "type": "object", - "properties": { - "principalName": { - "description": "Set to the principal name / UPN of the client JWT making the request.", - "type": "string" - }, - "principalId": { - "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", - "type": "string" - }, - "tenantId": { - "description": "Set to the tenant ID of the client JWT making the request.", - "type": "string" - }, - "objectId": { - "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", - "type": "string" - }, - "appId": { - "description": "Set to the app Id of the client JWT making the request.", - "type": "string" - } - } - }, - "UserProperties": { - "description": "Properties of a lab user profile.", - "type": "object", - "properties": { - "identity": { - "$ref": "#/definitions/UserIdentity", - "description": "The identity of the user." - }, - "secretStore": { - "$ref": "#/definitions/UserSecretStore", - "description": "The secret store of the user." - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the user profile.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "UserPropertiesFragment": { - "description": "Properties of a lab user profile.", - "type": "object", - "properties": { - "identity": { - "$ref": "#/definitions/UserIdentityFragment", - "description": "The identity of the user." - }, - "secretStore": { - "$ref": "#/definitions/UserSecretStoreFragment", - "description": "The secret store of the user." - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "UserSecretStore": { - "description": "Properties of a user's secret store.", - "type": "object", - "properties": { - "keyVaultUri": { - "description": "The URI of the user's Key vault.", - "type": "string" - }, - "keyVaultId": { - "description": "The ID of the user's Key vault.", - "type": "string" - } - } - }, - "UserSecretStoreFragment": { - "description": "Properties of a user's secret store.", - "type": "object", - "properties": { - "keyVaultUri": { - "description": "The URI of the user's Key vault.", - "type": "string" - }, - "keyVaultId": { - "description": "The ID of the user's Key vault.", - "type": "string" - } - } - }, - "VirtualNetwork": { - "description": "A virtual network.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/VirtualNetworkProperties", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "VirtualNetworkFragment": { - "description": "A virtual network.", - "type": "object", - "allOf": [ { "$ref": "#/definitions/Resource" } ], - "properties": { - "properties": { - "$ref": "#/definitions/VirtualNetworkPropertiesFragment", - "description": "The properties of the resource.", - "x-ms-client-flatten": true - } - } - }, - "VirtualNetworkProperties": { - "description": "Properties of a virtual network.", - "type": "object", - "properties": { - "allowedSubnets": { - "description": "The allowed subnets of the virtual network.", - "type": "array", - "items": { "$ref": "#/definitions/Subnet" } - }, - "description": { - "description": "The description of the virtual network.", - "type": "string" - }, - "externalProviderResourceId": { - "description": "The Microsoft.Network resource identifier of the virtual network.", - "type": "string" - }, - "externalSubnets": { - "description": "The external subnet properties.", - "type": "array", - "items": { "$ref": "#/definitions/ExternalSubnet" } - }, - "subnetOverrides": { - "description": "The subnet overrides of the virtual network.", - "type": "array", - "items": { "$ref": "#/definitions/SubnetOverride" } - }, - "createdDate": { - "format": "date-time", - "description": "The creation date of the virtual network.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "VirtualNetworkPropertiesFragment": { - "description": "Properties of a virtual network.", - "type": "object", - "properties": { - "allowedSubnets": { - "description": "The allowed subnets of the virtual network.", - "type": "array", - "items": { "$ref": "#/definitions/SubnetFragment" } - }, - "description": { - "description": "The description of the virtual network.", - "type": "string" - }, - "externalProviderResourceId": { - "description": "The Microsoft.Network resource identifier of the virtual network.", - "type": "string" - }, - "externalSubnets": { - "description": "The external subnet properties.", - "type": "array", - "items": { "$ref": "#/definitions/ExternalSubnetFragment" } - }, - "subnetOverrides": { - "description": "The subnet overrides of the virtual network.", - "type": "array", - "items": { "$ref": "#/definitions/SubnetOverrideFragment" } - }, - "provisioningState": { - "description": "The provisioning status of the resource.", - "type": "string" - }, - "uniqueIdentifier": { - "description": "The unique immutable identifier of a resource (Guid).", - "type": "string" - } - } - }, - "WeekDetails": { - "description": "Properties of a weekly schedule.", - "type": "object", - "properties": { - "weekdays": { - "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", - "type": "array", - "items": { "type": "string" } - }, - "time": { - "description": "The time of the day the schedule will occur.", - "type": "string" - } - } - }, - "WeekDetailsFragment": { - "description": "Properties of a weekly schedule.", - "type": "object", - "properties": { - "weekdays": { - "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", - "type": "array", - "items": { "type": "string" } - }, - "time": { - "description": "The time of the day the schedule will occur.", - "type": "string" - } - } - }, - "WindowsOsInfo": { - "description": "Information about a Windows OS.", - "type": "object", - "properties": { - "windowsOsState": { - "description": "The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).", - "enum": [ "NonSysprepped", "SysprepRequested", "SysprepApplied" ], - "type": "string", - "x-ms-enum": { - "name": "WindowsOsState", - "modelAsString": true - } - } - } - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "Client API version.", - "required": true, - "type": "string", - "default": "2016-05-15" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID.", - "required": true, - "type": "string" - }, - "locationName": { - "name": "locationName", - "in": "path", - "description": "The name of the location.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "OAuth2 Implicit Grant", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { "user_impersonation": "Access Microsoft Azure" } - } - }, - "security": [ { "azure_auth": [ "user_impersonation" ] } ] -} +{ + "swagger": "2.0", + "info": { + "version": "2016-05-15", + "title": "DevTestLabsClient", + "description": "The DevTest Labs Client." + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.DevTestLab/operations": { + "get": { + "tags": [ "ProviderOperations" ], + "description": "Result of the request to list REST API operations", + "operationId": "ProviderOperations_List", + "parameters": [ { "$ref": "#/parameters/api-version" } ], + "responses": { + "200": { + "description": "Success", + "schema": { "$ref": "#/definitions/ProviderOperationResult" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs": { + "get": { + "tags": [ "Labs" ], + "description": "List labs in a subscription.", + "operationId": "Labs_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Lab]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Lab" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}": { + "get": { + "tags": [ "Operations" ], + "description": "Get operation.", + "operationId": "Operations_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/locationName" }, + { + "name": "name", + "in": "path", + "description": "The name of the operation.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationResult" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "List schedules in a subscription.", + "operationId": "GlobalSchedules_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs": { + "get": { + "tags": [ "Labs" ], + "description": "List labs in a resource group.", + "operationId": "Labs_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Lab]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Lab" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources": { + "get": { + "tags": [ "ArtifactSources" ], + "description": "List artifact sources in a given lab.", + "operationId": "ArtifactSources_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[ArtifactSource]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ArtifactSource" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates": { + "get": { + "tags": [ "ArmTemplates" ], + "description": "List azure resource manager templates in a given artifact source.", + "operationId": "ArmTemplates_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[ArmTemplate]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ArmTemplate" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}": { + "get": { + "tags": [ "ArmTemplates" ], + "description": "Get azure resource manager template.", + "operationId": "ArmTemplates_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the azure Resource Manager template.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArmTemplate" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts": { + "get": { + "tags": [ "Artifacts" ], + "description": "List artifacts in a given artifact source.", + "operationId": "Artifacts_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=title)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Artifact]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Artifact" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}": { + "get": { + "tags": [ "Artifacts" ], + "description": "Get artifact.", + "operationId": "Artifacts_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=title)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Artifact" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate": { + "post": { + "tags": [ "Artifacts" ], + "description": "Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.", + "operationId": "Artifacts_GenerateArmTemplate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact.", + "required": true, + "type": "string" + }, + { + "name": "generateArmTemplateRequest", + "in": "body", + "description": "Parameters for generating an ARM template for deploying artifacts.", + "required": true, + "schema": { "$ref": "#/definitions/GenerateArmTemplateRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArmTemplateInfo" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}": { + "get": { + "tags": [ "ArtifactSources" ], + "description": "Get artifact source.", + "operationId": "ArtifactSources_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "ArtifactSources" ], + "description": "Create or replace an existing artifact source.", + "operationId": "ArtifactSources_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "artifactSource", + "in": "body", + "description": "Properties of an artifact source.", + "required": true, + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "ArtifactSources" ], + "description": "Delete artifact source.", + "operationId": "ArtifactSources_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "ArtifactSources" ], + "description": "Modify properties of artifact sources.", + "operationId": "ArtifactSources_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "artifactSource", + "in": "body", + "description": "Properties of an artifact source.", + "required": true, + "schema": { "$ref": "#/definitions/ArtifactSourceFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}": { + "get": { + "tags": [ "Costs" ], + "description": "Get cost.", + "operationId": "Costs_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the cost.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=labCostDetails)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Costs" ], + "description": "Create or replace an existing cost.", + "operationId": "Costs_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the cost.", + "required": true, + "type": "string" + }, + { + "name": "labCost", + "in": "body", + "description": "A cost item.", + "required": true, + "schema": { "$ref": "#/definitions/LabCost" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages": { + "get": { + "tags": [ "CustomImages" ], + "description": "List custom images in a given lab.", + "operationId": "CustomImages_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=vm)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[CustomImage]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/CustomImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}": { + "get": { + "tags": [ "CustomImages" ], + "description": "Get custom image.", + "operationId": "CustomImages_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=vm)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "CustomImages" ], + "description": "Create or replace an existing custom image. This operation can take a while to complete.", + "operationId": "CustomImages_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { + "name": "customImage", + "in": "body", + "description": "A custom image.", + "required": true, + "schema": { "$ref": "#/definitions/CustomImage" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "CustomImages" ], + "description": "Delete custom image. This operation can take a while to complete.", + "operationId": "CustomImages_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas": { + "get": { + "tags": [ "Formulas" ], + "description": "List formulas in a given lab.", + "operationId": "Formulas_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Formula]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Formula" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}": { + "get": { + "tags": [ "Formulas" ], + "description": "Get formula.", + "operationId": "Formulas_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Formula" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Formulas" ], + "description": "Create or replace an existing Formula. This operation can take a while to complete.", + "operationId": "Formulas_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { + "name": "formula", + "in": "body", + "description": "A formula for creating a VM, specifying an image base and other parameters", + "required": true, + "schema": { "$ref": "#/definitions/Formula" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Formula" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Formula" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Formulas" ], + "description": "Delete formula.", + "operationId": "Formulas_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages": { + "get": { + "tags": [ "GalleryImages" ], + "description": "List gallery images in a given lab.", + "operationId": "GalleryImages_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=author)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[GalleryImage]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/GalleryImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels": { + "get": { + "tags": [ "NotificationChannels" ], + "description": "List notificationchannels in a given lab.", + "operationId": "NotificationChannels_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[NotificationChannel]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/NotificationChannel" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}": { + "get": { + "tags": [ "NotificationChannels" ], + "description": "Get notificationchannel.", + "operationId": "NotificationChannels_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "NotificationChannels" ], + "description": "Create or replace an existing notificationChannel.", + "operationId": "NotificationChannels_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notificationChannel", + "in": "body", + "description": "A notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "NotificationChannels" ], + "description": "Delete notificationchannel.", + "operationId": "NotificationChannels_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "NotificationChannels" ], + "description": "Modify properties of notificationchannels.", + "operationId": "NotificationChannels_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notificationChannel", + "in": "body", + "description": "A notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotificationChannelFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify": { + "post": { + "tags": [ "NotificationChannels" ], + "description": "Send notification to provided channel.", + "operationId": "NotificationChannels_Notify", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notifyParameters", + "in": "body", + "description": "Properties for generating a Notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotifyParameters" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies": { + "post": { + "tags": [ "PolicySets" ], + "description": "Evaluates lab policy.", + "operationId": "PolicySets_EvaluatePolicies", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "evaluatePoliciesRequest", + "in": "body", + "description": "Request body for evaluating a policy set.", + "required": true, + "schema": { "$ref": "#/definitions/EvaluatePoliciesRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/EvaluatePoliciesResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies": { + "get": { + "tags": [ "Policies" ], + "description": "List policies in a given policy set.", + "operationId": "Policies_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Policy]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Policy" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}": { + "get": { + "tags": [ "Policies" ], + "description": "Get policy.", + "operationId": "Policies_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Policies" ], + "description": "Create or replace an existing policy.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "policy", + "in": "body", + "description": "A Policy.", + "required": true, + "schema": { "$ref": "#/definitions/Policy" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Policies" ], + "description": "Delete policy.", + "operationId": "Policies_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "Policies" ], + "description": "Modify properties of policies.", + "operationId": "Policies_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "policy", + "in": "body", + "description": "A Policy.", + "required": true, + "schema": { "$ref": "#/definitions/PolicyFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules": { + "get": { + "tags": [ "Schedules" ], + "description": "List schedules in a given lab.", + "operationId": "Schedules_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}": { + "get": { + "tags": [ "Schedules" ], + "description": "Get schedule.", + "operationId": "Schedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Schedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "Schedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Schedules" ], + "description": "Delete schedule.", + "operationId": "Schedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "Schedules" ], + "description": "Modify properties of schedules.", + "operationId": "Schedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute": { + "post": { + "tags": [ "Schedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "Schedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable": { + "post": { + "tags": [ "Schedules" ], + "description": "Lists all applicable schedules", + "operationId": "Schedules_ListApplicable", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners": { + "get": { + "tags": [ "ServiceRunners" ], + "description": "List service runners in a given lab.", + "operationId": "ServiceRunners_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[ServiceRunner]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ServiceRunner" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}": { + "get": { + "tags": [ "ServiceRunners" ], + "description": "Get service runner.", + "operationId": "ServiceRunners_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "ServiceRunners" ], + "description": "Create or replace an existing Service runner.", + "operationId": "ServiceRunners_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { + "name": "serviceRunner", + "in": "body", + "description": "A container for a managed identity to execute DevTest lab services.", + "required": true, + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "ServiceRunners" ], + "description": "Delete service runner.", + "operationId": "ServiceRunners_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users": { + "get": { + "tags": [ "Users" ], + "description": "List user profiles in a given lab.", + "operationId": "Users_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=identity)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[User]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/User" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}": { + "get": { + "tags": [ "Users" ], + "description": "Get user profile.", + "operationId": "Users_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=identity)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Users" ], + "description": "Create or replace an existing user profile.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "Profile of a lab user.", + "required": true, + "schema": { "$ref": "#/definitions/User" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Users" ], + "description": "Delete user profile. This operation can take a while to complete.", + "operationId": "Users_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Users" ], + "description": "Modify properties of user profiles.", + "operationId": "Users_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "Profile of a lab user.", + "required": true, + "schema": { "$ref": "#/definitions/UserFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks": { + "get": { + "tags": [ "Disks" ], + "description": "List disks in a given user profile.", + "operationId": "Disks_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=diskType)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Disk]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Disk" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}": { + "get": { + "tags": [ "Disks" ], + "description": "Get disk.", + "operationId": "Disks_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=diskType)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Disk" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Disks" ], + "description": "Create or replace an existing disk. This operation can take a while to complete.", + "operationId": "Disks_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "disk", + "in": "body", + "description": "A Disk.", + "required": true, + "schema": { "$ref": "#/definitions/Disk" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Disk" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Disk" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Disks" ], + "description": "Delete disk. This operation can take a while to complete.", + "operationId": "Disks_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach": { + "post": { + "tags": [ "Disks" ], + "description": "Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.", + "operationId": "Disks_Attach", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "attachDiskProperties", + "in": "body", + "description": "Properties of the disk to attach.", + "required": true, + "schema": { "$ref": "#/definitions/AttachDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach": { + "post": { + "tags": [ "Disks" ], + "description": "Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.", + "operationId": "Disks_Detach", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "detachDiskProperties", + "in": "body", + "description": "Properties of the disk to detach.", + "required": true, + "schema": { "$ref": "#/definitions/DetachDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments": { + "get": { + "tags": [ "Environments" ], + "description": "List environments in a given user profile.", + "operationId": "Environments_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[DtlEnvironment]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/DtlEnvironment" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}": { + "get": { + "tags": [ "Environments" ], + "description": "Get environment.", + "operationId": "Environments_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Environments" ], + "description": "Create or replace an existing environment. This operation can take a while to complete.", + "operationId": "Environments_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "dtlEnvironment", + "in": "body", + "description": "An environment, which is essentially an ARM template deployment.", + "required": true, + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Environments" ], + "description": "Delete environment. This operation can take a while to complete.", + "operationId": "Environments_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets": { + "get": { + "tags": [ "Secrets" ], + "description": "List secrets in a given user profile.", + "operationId": "Secrets_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=value)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Secret]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Secret" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}": { + "get": { + "tags": [ "Secrets" ], + "description": "Get secret.", + "operationId": "Secrets_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=value)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Secret" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Secrets" ], + "description": "Create or replace an existing secret.", + "operationId": "Secrets_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "A secret.", + "required": true, + "schema": { "$ref": "#/definitions/Secret" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Secret" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Secret" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Secrets" ], + "description": "Delete secret.", + "operationId": "Secrets_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines": { + "get": { + "tags": [ "VirtualMachines" ], + "description": "List virtual machines in a given lab.", + "operationId": "VirtualMachines_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabVirtualMachine]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/LabVirtualMachine" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}": { + "get": { + "tags": [ "VirtualMachines" ], + "description": "Get virtual machine.", + "operationId": "VirtualMachines_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "VirtualMachines" ], + "description": "Create or replace an existing Virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachine", + "in": "body", + "description": "A virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "VirtualMachines" ], + "description": "Delete virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "VirtualMachines" ], + "description": "Modify properties of virtual machines.", + "operationId": "VirtualMachines_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachine", + "in": "body", + "description": "A virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachineFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Attach a new or existing data disk to virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_AddDataDisk", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "dataDiskProperties", + "in": "body", + "description": "Request body for adding a new or existing data disk to a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/DataDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Apply artifacts to virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_ApplyArtifacts", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "applyArtifactsRequest", + "in": "body", + "description": "Request body for applying artifacts to a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/ApplyArtifactsRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Take ownership of an existing virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_Claim", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Detach the specified disk from the virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_DetachDataDisk", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "detachDataDiskProperties", + "in": "body", + "description": "Request body for detaching data disk from a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/DetachDataDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Lists all applicable schedules", + "operationId": "VirtualMachines_ListApplicableSchedules", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ApplicableSchedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Start a virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Start", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Stop a virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_Stop", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules": { + "get": { + "tags": [ "VirtualMachineSchedules" ], + "description": "List schedules in a given virtual machine.", + "operationId": "VirtualMachineSchedules_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}": { + "get": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Get schedule.", + "operationId": "VirtualMachineSchedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "VirtualMachineSchedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Delete schedule.", + "operationId": "VirtualMachineSchedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Modify properties of schedules.", + "operationId": "VirtualMachineSchedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute": { + "post": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "VirtualMachineSchedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks": { + "get": { + "tags": [ "VirtualNetworks" ], + "description": "List virtual networks in a given lab.", + "operationId": "VirtualNetworks_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[VirtualNetwork]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/VirtualNetwork" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}": { + "get": { + "tags": [ "VirtualNetworks" ], + "description": "Get virtual network.", + "operationId": "VirtualNetworks_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "VirtualNetworks" ], + "description": "Create or replace an existing virtual network. This operation can take a while to complete.", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "virtualNetwork", + "in": "body", + "description": "A virtual network.", + "required": true, + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "VirtualNetworks" ], + "description": "Delete virtual network. This operation can take a while to complete.", + "operationId": "VirtualNetworks_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "VirtualNetworks" ], + "description": "Modify properties of virtual networks.", + "operationId": "VirtualNetworks_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "virtualNetwork", + "in": "body", + "description": "A virtual network.", + "required": true, + "schema": { "$ref": "#/definitions/VirtualNetworkFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}": { + "get": { + "tags": [ "Labs" ], + "description": "Get lab.", + "operationId": "Labs_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Labs" ], + "description": "Create or replace an existing lab. This operation can take a while to complete.", + "operationId": "Labs_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "A lab.", + "required": true, + "schema": { "$ref": "#/definitions/Lab" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Labs" ], + "description": "Delete lab. This operation can take a while to complete.", + "operationId": "Labs_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Labs" ], + "description": "Modify properties of labs.", + "operationId": "Labs_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "A lab.", + "required": true, + "schema": { "$ref": "#/definitions/LabFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm": { + "post": { + "tags": [ "Labs" ], + "description": "Claim a random claimable virtual machine in the lab. This operation can take a while to complete.", + "operationId": "Labs_ClaimAnyVm", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment": { + "post": { + "tags": [ "Labs" ], + "description": "Create virtual machines in a lab. This operation can take a while to complete.", + "operationId": "Labs_CreateEnvironment", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachineCreationParameter", + "in": "body", + "description": "Properties for creating a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachineCreationParameter" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage": { + "post": { + "tags": [ "Labs" ], + "description": "Exports the lab resource usage into a storage account This operation can take a while to complete.", + "operationId": "Labs_ExportResourceUsage", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "exportResourceUsageParameters", + "in": "body", + "description": "The parameters of the export operation.", + "required": true, + "schema": { "$ref": "#/definitions/ExportResourceUsageParameters" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri": { + "post": { + "tags": [ "Labs" ], + "description": "Generate a URI for uploading custom disk images to a Lab.", + "operationId": "Labs_GenerateUploadUri", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "generateUploadUriParameter", + "in": "body", + "description": "Properties for generating an upload URI.", + "required": true, + "schema": { "$ref": "#/definitions/GenerateUploadUriParameter" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GenerateUploadUriResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds": { + "post": { + "tags": [ "Labs" ], + "description": "List disk images available for custom image creation.", + "operationId": "Labs_ListVhds", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabVhd]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "List schedules in a resource group.", + "operationId": "GlobalSchedules_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Schedule]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "Get schedule.", + "operationId": "GlobalSchedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "GlobalSchedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "GlobalSchedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "GlobalSchedules" ], + "description": "Delete schedule.", + "operationId": "GlobalSchedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "GlobalSchedules" ], + "description": "Modify properties of schedules.", + "operationId": "GlobalSchedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute": { + "post": { + "tags": [ "GlobalSchedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "GlobalSchedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget": { + "post": { + "tags": [ "GlobalSchedules" ], + "description": "Updates a schedule's target resource Id. This operation can take a while to complete.", + "operationId": "GlobalSchedules_Retarget", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "retargetScheduleProperties", + "in": "body", + "description": "Properties for retargeting a virtual machine schedule.", + "required": true, + "schema": { "$ref": "#/definitions/RetargetScheduleProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicableSchedule": { + "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicableScheduleProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ApplicableScheduleFragment": { + "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicableSchedulePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ApplicableScheduleProperties": { + "description": "Properties of a schedules applicable to a virtual machine.", + "type": "object", + "properties": { + "labVmsShutdown": { + "$ref": "#/definitions/Schedule", + "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." + }, + "labVmsStartup": { + "$ref": "#/definitions/Schedule", + "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." + } + } + }, + "ApplicableSchedulePropertiesFragment": { + "description": "Properties of a schedules applicable to a virtual machine.", + "type": "object", + "properties": { + "labVmsShutdown": { + "$ref": "#/definitions/ScheduleFragment", + "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." + }, + "labVmsStartup": { + "$ref": "#/definitions/ScheduleFragment", + "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." + } + } + }, + "ApplyArtifactsRequest": { + "description": "Request body for applying artifacts to a virtual machine.", + "type": "object", + "properties": { + "artifacts": { + "description": "The list of artifacts to apply.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + } + } + }, + "ArmTemplate": { + "description": "An Azure Resource Manager template.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArmTemplateProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArmTemplateInfo": { + "description": "Information about a generated ARM template.", + "type": "object", + "properties": { + "template": { + "description": "The template's contents.", + "type": "object" + }, + "parameters": { + "description": "The parameters of the ARM template.", + "type": "object" + } + } + }, + "ArmTemplateParameterProperties": { + "description": "Properties of an Azure Resource Manager template parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the template parameter.", + "type": "string" + }, + "value": { + "description": "The value of the template parameter.", + "type": "string" + } + } + }, + "ArmTemplateProperties": { + "description": "Properties of an Azure Resource Manager template.", + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the ARM template.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the ARM template.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the ARM template.", + "type": "string", + "readOnly": true + }, + "icon": { + "description": "The URI to the icon of the ARM template.", + "type": "string", + "readOnly": true + }, + "contents": { + "description": "The contents of the ARM template.", + "type": "object", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the armTemplate.", + "type": "string", + "readOnly": true + }, + "parametersValueFilesInfo": { + "description": "File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.", + "type": "array", + "items": { "$ref": "#/definitions/ParametersValueFileInfo" }, + "readOnly": true + } + } + }, + "Artifact": { + "description": "An artifact.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactDeploymentStatusProperties": { + "description": "Properties of an artifact deployment.", + "type": "object", + "properties": { + "deploymentStatus": { + "description": "The deployment status of the artifact.", + "type": "string" + }, + "artifactsApplied": { + "format": "int32", + "description": "The total count of the artifacts that were successfully applied.", + "type": "integer" + }, + "totalArtifacts": { + "format": "int32", + "description": "The total count of the artifacts that were tentatively applied.", + "type": "integer" + } + } + }, + "ArtifactDeploymentStatusPropertiesFragment": { + "description": "Properties of an artifact deployment.", + "type": "object", + "properties": { + "deploymentStatus": { + "description": "The deployment status of the artifact.", + "type": "string" + }, + "artifactsApplied": { + "format": "int32", + "description": "The total count of the artifacts that were successfully applied.", + "type": "integer" + }, + "totalArtifacts": { + "format": "int32", + "description": "The total count of the artifacts that were tentatively applied.", + "type": "integer" + } + } + }, + "ArtifactInstallProperties": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "artifactId": { + "description": "The artifact's identifier.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the artifact.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactParameterProperties" } + }, + "status": { + "description": "The status of the artifact.", + "type": "string" + }, + "deploymentStatusMessage": { + "description": "The status message from the deployment.", + "type": "string" + }, + "vmExtensionStatusMessage": { + "description": "The status message from the virtual machine extension.", + "type": "string" + }, + "installTime": { + "format": "date-time", + "description": "The time that the artifact starts to install on the virtual machine.", + "type": "string" + } + } + }, + "ArtifactInstallPropertiesFragment": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "artifactId": { + "description": "The artifact's identifier.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the artifact.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactParameterPropertiesFragment" } + }, + "status": { + "description": "The status of the artifact.", + "type": "string" + }, + "deploymentStatusMessage": { + "description": "The status message from the deployment.", + "type": "string" + }, + "vmExtensionStatusMessage": { + "description": "The status message from the virtual machine extension.", + "type": "string" + }, + "installTime": { + "format": "date-time", + "description": "The time that the artifact starts to install on the virtual machine.", + "type": "string" + } + } + }, + "ArtifactParameterProperties": { + "description": "Properties of an artifact parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ArtifactParameterPropertiesFragment": { + "description": "Properties of an artifact parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ArtifactProperties": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "title": { + "description": "The artifact's title.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The artifact's description.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The artifact's publisher.", + "type": "string", + "readOnly": true + }, + "filePath": { + "description": "The file path to the artifact.", + "type": "string", + "readOnly": true + }, + "icon": { + "description": "The URI to the artifact icon.", + "type": "string", + "readOnly": true + }, + "targetOsType": { + "description": "The artifact's target OS.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The artifact's parameters.", + "type": "object", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "The artifact's creation date.", + "type": "string", + "readOnly": true + } + } + }, + "ArtifactSource": { + "description": "Properties of an artifact source.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactSourceProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactSourceFragment": { + "description": "Properties of an artifact source.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactSourcePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactSourceProperties": { + "description": "Properties of an artifact source.", + "type": "object", + "properties": { + "displayName": { + "description": "The artifact source's display name.", + "type": "string" + }, + "uri": { + "description": "The artifact source's URI.", + "type": "string" + }, + "sourceType": { + "description": "The artifact source's type.", + "enum": [ "VsoGit", "GitHub" ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "folderPath": { + "description": "The folder containing artifacts.", + "type": "string" + }, + "armTemplateFolderPath": { + "description": "The folder containing Azure Resource Manager templates.", + "type": "string" + }, + "branchRef": { + "description": "The artifact source's branch reference.", + "type": "string" + }, + "securityToken": { + "description": "The security token to authenticate to the artifact source.", + "type": "string" + }, + "status": { + "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "createdDate": { + "format": "date-time", + "description": "The artifact source's creation date.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "ArtifactSourcePropertiesFragment": { + "description": "Properties of an artifact source.", + "type": "object", + "properties": { + "displayName": { + "description": "The artifact source's display name.", + "type": "string" + }, + "uri": { + "description": "The artifact source's URI.", + "type": "string" + }, + "sourceType": { + "description": "The artifact source's type.", + "enum": [ "VsoGit", "GitHub" ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "folderPath": { + "description": "The folder containing artifacts.", + "type": "string" + }, + "armTemplateFolderPath": { + "description": "The folder containing Azure Resource Manager templates.", + "type": "string" + }, + "branchRef": { + "description": "The artifact source's branch reference.", + "type": "string" + }, + "securityToken": { + "description": "The security token to authenticate to the artifact source.", + "type": "string" + }, + "status": { + "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "AttachDiskProperties": { + "description": "Properties of the disk to attach.", + "type": "object", + "properties": { + "leasedByLabVmId": { + "description": "The resource ID of the Lab virtual machine to which the disk is attached.", + "type": "string" + } + } + }, + "AttachNewDataDiskOptions": { + "description": "Properties to attach new disk to the Virtual Machine.", + "type": "object", + "properties": { + "diskSizeGiB": { + "format": "int32", + "description": "Size of the disk to be attached in GibiBytes.", + "type": "integer" + }, + "diskName": { + "description": "The name of the disk to be attached.", + "type": "string" + }, + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + } + }, + "BulkCreationParameters": { + "description": "Parameters for creating multiple virtual machines as a single action.", + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "The number of virtual machine instances to create.", + "type": "integer" + } + } + }, + "CloudError": { + "description": "Error from a REST request.", + "type": "object", + "properties": { "error": { "$ref": "#/definitions/CloudErrorBody" } }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "Body of an error from a REST request.", + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "target": { "type": "string" }, + "details": { + "description": "Inner errors.", + "type": "array", + "items": { "$ref": "#/definitions/CloudErrorBody" } + } + }, + "x-ms-external": true + }, + "ComputeDataDisk": { + "description": "A data disks attached to a virtual machine.", + "type": "object", + "properties": { + "name": { + "description": "Gets data disk name.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "diskSizeGiB": { + "format": "int32", + "description": "Gets data disk size in GiB.", + "type": "integer" + } + } + }, + "ComputeDataDiskFragment": { + "description": "A data disks attached to a virtual machine.", + "type": "object", + "properties": { + "name": { + "description": "Gets data disk name.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "diskSizeGiB": { + "format": "int32", + "description": "Gets data disk size in GiB.", + "type": "integer" + } + } + }, + "ComputeVmInstanceViewStatus": { + "description": "Status information about a virtual machine.", + "type": "object", + "properties": { + "code": { + "description": "Gets the status Code.", + "type": "string" + }, + "displayStatus": { + "description": "Gets the short localizable label for the status.", + "type": "string" + }, + "message": { + "description": "Gets the message associated with the status.", + "type": "string" + } + } + }, + "ComputeVmInstanceViewStatusFragment": { + "description": "Status information about a virtual machine.", + "type": "object", + "properties": { + "code": { + "description": "Gets the status Code.", + "type": "string" + }, + "displayStatus": { + "description": "Gets the short localizable label for the status.", + "type": "string" + }, + "message": { + "description": "Gets the message associated with the status.", + "type": "string" + } + } + }, + "ComputeVmProperties": { + "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", + "type": "object", + "properties": { + "statuses": { + "description": "Gets the statuses of the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatus" } + }, + "osType": { + "description": "Gets the OS type of the virtual machine.", + "type": "string" + }, + "vmSize": { + "description": "Gets the size of the virtual machine.", + "type": "string" + }, + "networkInterfaceId": { + "description": "Gets the network interface ID of the virtual machine.", + "type": "string" + }, + "osDiskId": { + "description": "Gets OS disk blob uri for the virtual machine.", + "type": "string" + }, + "dataDiskIds": { + "description": "Gets data disks blob uri for the virtual machine.", + "type": "array", + "items": { "type": "string" } + }, + "dataDisks": { + "description": "Gets all data disks attached to the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeDataDisk" } + } + } + }, + "ComputeVmPropertiesFragment": { + "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", + "type": "object", + "properties": { + "statuses": { + "description": "Gets the statuses of the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatusFragment" } + }, + "osType": { + "description": "Gets the OS type of the virtual machine.", + "type": "string" + }, + "vmSize": { + "description": "Gets the size of the virtual machine.", + "type": "string" + }, + "networkInterfaceId": { + "description": "Gets the network interface ID of the virtual machine.", + "type": "string" + }, + "osDiskId": { + "description": "Gets OS disk blob uri for the virtual machine.", + "type": "string" + }, + "dataDiskIds": { + "description": "Gets data disks blob uri for the virtual machine.", + "type": "array", + "items": { "type": "string" } + }, + "dataDisks": { + "description": "Gets all data disks attached to the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeDataDiskFragment" } + } + } + }, + "CostThresholdProperties": { + "description": "Properties of a cost threshold item.", + "type": "object", + "properties": { + "thresholdId": { + "description": "The ID of the cost threshold item.", + "type": "string" + }, + "percentageThreshold": { + "$ref": "#/definitions/PercentageCostThresholdProperties", + "description": "The value of the percentage cost threshold." + }, + "displayOnChart": { + "description": "Indicates whether this threshold will be displayed on cost charts.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "CostThresholdStatus", + "modelAsString": true + } + }, + "sendNotificationWhenExceeded": { + "description": "Indicates whether notifications will be sent when this threshold is exceeded.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "CostThresholdStatus", + "modelAsString": true + } + }, + "notificationSent": { + "description": "Indicates the datetime when notifications were last sent for this threshold.", + "type": "string" + } + } + }, + "CustomImage": { + "description": "A custom image.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomImageProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "CustomImageProperties": { + "description": "Properties of a custom image.", + "type": "object", + "properties": { + "vm": { + "$ref": "#/definitions/CustomImagePropertiesFromVm", + "description": "The virtual machine from which the image is to be created." + }, + "vhd": { + "$ref": "#/definitions/CustomImagePropertiesCustom", + "description": "The VHD from which the image is to be created." + }, + "description": { + "description": "The description of the custom image.", + "type": "string" + }, + "author": { + "description": "The author of the custom image.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the custom image.", + "type": "string", + "readOnly": true + }, + "managedImageId": { + "description": "The Managed Image Id backing the custom image.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "CustomImagePropertiesCustom": { + "description": "Properties for creating a custom image from a VHD.", + "required": [ "osType" ], + "type": "object", + "properties": { + "imageName": { + "description": "The image name.", + "type": "string" + }, + "sysPrep": { + "description": "Indicates whether sysprep has been run on the VHD.", + "type": "boolean" + }, + "osType": { + "description": "The OS type of the custom image (i.e. Windows, Linux)", + "enum": [ "Windows", "Linux", "None" ], + "type": "string", + "x-ms-enum": { + "name": "CustomImageOsType", + "modelAsString": true + } + } + } + }, + "CustomImagePropertiesFromVm": { + "description": "Properties for creating a custom image from a virtual machine.", + "type": "object", + "properties": { + "sourceVmId": { + "description": "The source vm identifier.", + "type": "string" + }, + "windowsOsInfo": { + "$ref": "#/definitions/WindowsOsInfo", + "description": "The Windows OS information of the VM." + }, + "linuxOsInfo": { + "$ref": "#/definitions/LinuxOsInfo", + "description": "The Linux OS information of the VM." + } + } + }, + "DataDiskProperties": { + "description": "Request body for adding a new or existing data disk to a virtual machine.", + "type": "object", + "properties": { + "attachNewDataDiskOptions": { + "$ref": "#/definitions/AttachNewDataDiskOptions", + "description": "Specifies options to attach a new disk to the virtual machine." + }, + "existingLabDiskId": { + "description": "Specifies the existing lab disk id to attach to virtual machine.", + "type": "string" + }, + "hostCaching": { + "description": "Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).", + "enum": [ "None", "ReadOnly", "ReadWrite" ], + "type": "string", + "x-ms-enum": { + "name": "HostCachingOptions", + "modelAsString": true + } + } + } + }, + "DayDetails": { + "description": "Properties of a daily schedule.", + "type": "object", + "properties": { + "time": { + "description": "The time of day the schedule will occur.", + "type": "string" + } + } + }, + "DayDetailsFragment": { + "description": "Properties of a daily schedule.", + "type": "object", + "properties": { + "time": { + "description": "The time of day the schedule will occur.", + "type": "string" + } + } + }, + "DetachDataDiskProperties": { + "description": "Request body for detaching data disk from a virtual machine.", + "type": "object", + "properties": { + "existingLabDiskId": { + "description": "Specifies the disk resource ID to detach from virtual machine.", + "type": "string" + } + } + }, + "DetachDiskProperties": { + "description": "Properties of the disk to detach.", + "type": "object", + "properties": { + "leasedByLabVmId": { + "description": "The resource ID of the Lab VM to which the disk is attached.", + "type": "string" + } + } + }, + "Disk": { + "description": "A Disk.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/DiskProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DiskProperties": { + "description": "Properties of a disk.", + "type": "object", + "properties": { + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "diskSizeGiB": { + "format": "int32", + "description": "The size of the disk in GibiBytes.", + "type": "integer" + }, + "leasedByLabVmId": { + "description": "The resource ID of the VM to which this disk is leased.", + "type": "string" + }, + "diskBlobName": { + "description": "When backed by a blob, the name of the VHD blob without extension.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the disk.", + "type": "string", + "readOnly": true + }, + "hostCaching": { + "description": "The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "DtlEnvironment": { + "description": "An environment, which is essentially an ARM template deployment.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "EnvironmentDeploymentProperties": { + "description": "Properties of an environment deployment.", + "type": "object", + "properties": { + "armTemplateId": { + "description": "The Azure Resource Manager template's identifier.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the Azure Resource Manager template.", + "type": "array", + "items": { "$ref": "#/definitions/ArmTemplateParameterProperties" } + } + } + }, + "EnvironmentProperties": { + "description": "Properties of an environment.", + "type": "object", + "properties": { + "deploymentProperties": { + "$ref": "#/definitions/EnvironmentDeploymentProperties", + "description": "The deployment properties of the environment." + }, + "armTemplateDisplayName": { + "description": "The display name of the Azure Resource Manager template that produced the environment.", + "type": "string" + }, + "resourceGroupId": { + "description": "The identifier of the resource group containing the environment's resources.", + "type": "string", + "readOnly": true + }, + "createdByUser": { + "description": "The creator of the environment.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "EvaluatePoliciesProperties": { + "description": "Properties for evaluating a policy set.", + "type": "object", + "properties": { + "factName": { + "description": "The fact name.", + "type": "string" + }, + "factData": { + "description": "The fact data.", + "type": "string" + }, + "valueOffset": { + "description": "The value offset.", + "type": "string" + } + } + }, + "EvaluatePoliciesRequest": { + "description": "Request body for evaluating a policy set.", + "type": "object", + "properties": { + "policies": { + "description": "Policies to evaluate.", + "type": "array", + "items": { "$ref": "#/definitions/EvaluatePoliciesProperties" } + } + } + }, + "EvaluatePoliciesResponse": { + "description": "Response body for evaluating a policy set.", + "type": "object", + "properties": { + "results": { + "description": "Results of evaluating a policy set.", + "type": "array", + "items": { "$ref": "#/definitions/PolicySetResult" } + } + } + }, + "Event": { + "description": "An event to be notified for.", + "type": "object", + "properties": { + "eventName": { + "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + } + } + }, + "EventFragment": { + "description": "An event to be notified for.", + "type": "object", + "properties": { + "eventName": { + "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + } + } + }, + "ExportResourceUsageParameters": { + "description": "The parameters of the export operation.", + "type": "object", + "properties": { + "blobStorageAbsoluteSasUri": { + "description": "The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to.", + "type": "string" + }, + "usageStartDate": { + "format": "date-time", + "description": "The start time of the usage. If not provided, usage will be reported since the beginning of data collection.", + "type": "string" + } + } + }, + "ExternalSubnet": { + "description": "Subnet information as returned by the Microsoft.Network API.", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string" + } + } + }, + "ExternalSubnetFragment": { + "description": "Subnet information as returned by the Microsoft.Network API.", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string" + } + } + }, + "Formula": { + "description": "A formula for creating a VM, specifying an image base and other parameters", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/FormulaProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "FormulaProperties": { + "description": "Properties of a formula.", + "type": "object", + "properties": { + "description": { + "description": "The description of the formula.", + "type": "string" + }, + "author": { + "description": "The author of the formula.", + "type": "string" + }, + "osType": { + "description": "The OS type of the formula.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the formula.", + "type": "string", + "readOnly": true + }, + "formulaContent": { + "$ref": "#/definitions/LabVirtualMachineCreationParameter", + "description": "The content of the formula." + }, + "vm": { + "$ref": "#/definitions/FormulaPropertiesFromVm", + "description": "Information about a VM from which a formula is to be created." + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "FormulaPropertiesFromVm": { + "description": "Information about a VM from which a formula is to be created.", + "type": "object", + "properties": { + "labVmId": { + "description": "The identifier of the VM from which a formula is to be created.", + "type": "string" + } + } + }, + "GalleryImage": { + "description": "A gallery image.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageProperties": { + "description": "Properties of a gallery image.", + "type": "object", + "properties": { + "author": { + "description": "The author of the gallery image.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the gallery image.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the gallery image.", + "type": "string" + }, + "imageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The image reference of the gallery image." + }, + "icon": { + "description": "The icon of the gallery image.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether this gallery image is enabled.", + "type": "boolean" + } + } + }, + "GalleryImageReference": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GalleryImageReferenceFragment": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GenerateArmTemplateRequest": { + "description": "Parameters for generating an ARM template for deploying artifacts.", + "type": "object", + "properties": { + "virtualMachineName": { + "description": "The resource name of the virtual machine.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the ARM template.", + "type": "array", + "items": { "$ref": "#/definitions/ParameterInfo" } + }, + "location": { + "description": "The location of the virtual machine.", + "type": "string" + }, + "fileUploadOptions": { + "description": "Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value.", + "enum": [ "UploadFilesAndGenerateSasTokens", "None" ], + "type": "string", + "x-ms-enum": { + "name": "FileUploadOptions", + "modelAsString": true + } + } + } + }, + "GenerateUploadUriParameter": { + "description": "Properties for generating an upload URI.", + "type": "object", + "properties": { + "blobName": { + "description": "The blob name of the upload URI.", + "type": "string" + } + } + }, + "GenerateUploadUriResponse": { + "description": "Reponse body for generating an upload URI.", + "type": "object", + "properties": { + "uploadUri": { + "description": "The upload URI for the VHD.", + "type": "string" + } + } + }, + "HourDetails": { + "description": "Properties of an hourly schedule.", + "type": "object", + "properties": { + "minute": { + "format": "int32", + "description": "Minutes of the hour the schedule will run.", + "type": "integer" + } + } + }, + "HourDetailsFragment": { + "description": "Properties of an hourly schedule.", + "type": "object", + "properties": { + "minute": { + "format": "int32", + "description": "Minutes of the hour the schedule will run.", + "type": "integer" + } + } + }, + "IdentityProperties": { + "description": "Properties of a managed identity", + "type": "object", + "properties": { + "type": { + "description": "Managed identity.", + "type": "string" + }, + "principalId": { + "description": "The principal id of resource identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant identifier of resource.", + "type": "string" + }, + "clientSecretUrl": { + "description": "The client secret URL of the identity.", + "type": "string" + } + } + }, + "InboundNatRule": { + "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "The transport protocol for the endpoint.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "frontendPort": { + "format": "int32", + "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", + "type": "integer" + }, + "backendPort": { + "format": "int32", + "description": "The port to which the external traffic will be redirected.", + "type": "integer" + } + } + }, + "InboundNatRuleFragment": { + "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "The transport protocol for the endpoint.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "frontendPort": { + "format": "int32", + "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", + "type": "integer" + }, + "backendPort": { + "format": "int32", + "description": "The port to which the external traffic will be redirected.", + "type": "integer" + } + } + }, + "Lab": { + "description": "A lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabCost": { + "description": "A cost item.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabCostProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabCostDetailsProperties": { + "description": "The properties of a lab cost item.", + "type": "object", + "properties": { + "date": { + "format": "date-time", + "description": "The date of the cost item.", + "type": "string" + }, + "cost": { + "format": "double", + "description": "The cost component of the cost item.", + "type": "number" + }, + "costType": { + "description": "The type of the cost.", + "enum": [ "Unavailable", "Reported", "Projected" ], + "type": "string", + "x-ms-enum": { + "name": "CostType", + "modelAsString": true + } + } + } + }, + "LabCostProperties": { + "description": "Properties of a cost item.", + "type": "object", + "properties": { + "targetCost": { + "$ref": "#/definitions/TargetCostProperties", + "description": "The target cost properties" + }, + "labCostSummary": { + "$ref": "#/definitions/LabCostSummaryProperties", + "description": "The lab cost summary component of the cost data.", + "readOnly": true + }, + "labCostDetails": { + "description": "The lab cost details component of the cost data.", + "type": "array", + "items": { "$ref": "#/definitions/LabCostDetailsProperties" }, + "readOnly": true + }, + "resourceCosts": { + "description": "The resource cost component of the cost data.", + "type": "array", + "items": { "$ref": "#/definitions/LabResourceCostProperties" }, + "readOnly": true + }, + "currencyCode": { + "description": "The currency code of the cost.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "The start time of the cost data.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "The end time of the cost data.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the cost.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabCostSummaryProperties": { + "description": "The properties of the cost summary.", + "type": "object", + "properties": { + "estimatedLabCost": { + "format": "double", + "description": "The cost component of the cost item.", + "type": "number" + } + } + }, + "LabFragment": { + "description": "A lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabProperties": { + "description": "Properties of a lab.", + "type": "object", + "properties": { + "defaultStorageAccount": { + "description": "The lab's default storage account.", + "type": "string", + "readOnly": true + }, + "defaultPremiumStorageAccount": { + "description": "The lab's default premium storage account.", + "type": "string", + "readOnly": true + }, + "artifactsStorageAccount": { + "description": "The lab's artifact storage account.", + "type": "string", + "readOnly": true + }, + "premiumDataDiskStorageAccount": { + "description": "The lab's premium data disk storage account.", + "type": "string", + "readOnly": true + }, + "vaultName": { + "description": "The lab's Key vault.", + "type": "string", + "readOnly": true + }, + "labStorageType": { + "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the lab.", + "type": "string", + "readOnly": true + }, + "premiumDataDisks": { + "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "PremiumDataDisk", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabPropertiesFragment": { + "description": "Properties of a lab.", + "type": "object", + "properties": { + "labStorageType": { + "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "premiumDataDisks": { + "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "PremiumDataDisk", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabResourceCostProperties": { + "description": "The properties of a resource cost item.", + "type": "object", + "properties": { + "resourcename": { + "description": "The name of the resource.", + "type": "string" + }, + "resourceUId": { + "description": "The unique identifier of the resource.", + "type": "string" + }, + "resourceCost": { + "format": "double", + "description": "The cost component of the resource cost item.", + "type": "number" + }, + "resourceType": { + "description": "The logical resource type (ex. virtualmachine, storageaccount)", + "type": "string" + }, + "resourceOwner": { + "description": "The owner of the resource (ex. janedoe@microsoft.com)", + "type": "string" + }, + "resourcePricingTier": { + "description": "The category of the resource (ex. Premium_LRS, Standard_DS1)", + "type": "string" + }, + "resourceStatus": { + "description": "The status of the resource (ex. Active)", + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource", + "type": "string" + }, + "externalResourceId": { + "description": "The ID of the external resource", + "type": "string" + } + } + }, + "LabVhd": { + "description": "Properties of a VHD in the lab.", + "type": "object", + "properties": { + "id": { + "description": "The URI to the VHD.", + "type": "string" + } + } + }, + "LabVirtualMachine": { + "description": "A virtual machine.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachineProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabVirtualMachineCreationParameter": { + "description": "Properties for creating a virtual machine.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachineCreationParameterProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + }, + "name": { + "description": "The name of the virtual machine or environment", + "type": "string" + }, + "location": { + "description": "The location of the new virtual machine or environment", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "LabVirtualMachineCreationParameterProperties": { + "description": "Properties for virtual machine creation.", + "type": "object", + "properties": { + "bulkCreationParameters": { + "$ref": "#/definitions/BulkCreationParameters", + "description": "The number of virtual machine instances to create." + }, + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusProperties", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "computeVm": { + "$ref": "#/definitions/ComputeVmProperties", + "description": "The compute virtual machine properties." + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The network interface properties." + }, + "applicableSchedule": { + "$ref": "#/definitions/ApplicableSchedule", + "description": "The applicable schedule for the virtual machine." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabVirtualMachineFragment": { + "description": "A virtual machine.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachinePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabVirtualMachineProperties": { + "description": "Properties of a virtual machine.", + "type": "object", + "properties": { + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "computeId": { + "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", + "type": "string", + "readOnly": true + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusProperties", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "computeVm": { + "$ref": "#/definitions/ComputeVmProperties", + "description": "The compute virtual machine properties." + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The network interface properties." + }, + "applicableSchedule": { + "$ref": "#/definitions/ApplicableSchedule", + "description": "The applicable schedule for the virtual machine." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabVirtualMachinePropertiesFragment": { + "description": "Properties of a virtual machine.", + "type": "object", + "properties": { + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallPropertiesFragment" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusPropertiesFragment", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReferenceFragment", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "computeVm": { + "$ref": "#/definitions/ComputeVmPropertiesFragment", + "description": "The compute virtual machine properties." + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfacePropertiesFragment", + "description": "The network interface properties." + }, + "applicableSchedule": { + "$ref": "#/definitions/ApplicableScheduleFragment", + "description": "The applicable schedule for the virtual machine." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LinuxOsInfo": { + "description": "Information about a Linux OS.", + "type": "object", + "properties": { + "linuxOsState": { + "description": "The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).", + "enum": [ "NonDeprovisioned", "DeprovisionRequested", "DeprovisionApplied" ], + "type": "string", + "x-ms-enum": { + "name": "LinuxOsState", + "modelAsString": true + } + } + } + }, + "NetworkInterfaceProperties": { + "description": "Properties of a network interface.", + "type": "object", + "properties": { + "virtualNetworkId": { + "description": "The resource ID of the virtual network.", + "type": "string" + }, + "subnetId": { + "description": "The resource ID of the sub net.", + "type": "string" + }, + "publicIpAddressId": { + "description": "The resource ID of the public IP address.", + "type": "string" + }, + "publicIpAddress": { + "description": "The public IP address.", + "type": "string" + }, + "privateIpAddress": { + "description": "The private IP address.", + "type": "string" + }, + "dnsName": { + "description": "The DNS name.", + "type": "string" + }, + "rdpAuthority": { + "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", + "type": "string" + }, + "sshAuthority": { + "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", + "type": "string" + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SharedPublicIpAddressConfiguration", + "description": "The configuration for sharing a public IP address across multiple virtual machines." + } + } + }, + "NetworkInterfacePropertiesFragment": { + "description": "Properties of a network interface.", + "type": "object", + "properties": { + "virtualNetworkId": { + "description": "The resource ID of the virtual network.", + "type": "string" + }, + "subnetId": { + "description": "The resource ID of the sub net.", + "type": "string" + }, + "publicIpAddressId": { + "description": "The resource ID of the public IP address.", + "type": "string" + }, + "publicIpAddress": { + "description": "The public IP address.", + "type": "string" + }, + "privateIpAddress": { + "description": "The private IP address.", + "type": "string" + }, + "dnsName": { + "description": "The DNS name.", + "type": "string" + }, + "rdpAuthority": { + "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", + "type": "string" + }, + "sshAuthority": { + "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", + "type": "string" + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SharedPublicIpAddressConfigurationFragment", + "description": "The configuration for sharing a public IP address across multiple virtual machines." + } + } + }, + "NotificationChannel": { + "description": "A notification.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NotificationChannelProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "NotificationChannelFragment": { + "description": "A notification.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NotificationChannelPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "NotificationChannelProperties": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "webHookUrl": { + "description": "The webhook URL to send notifications to.", + "type": "string" + }, + "description": { + "description": "Description of notification.", + "type": "string" + }, + "events": { + "description": "The list of event for which this notification is enabled.", + "type": "array", + "items": { "$ref": "#/definitions/Event" } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the notification channel.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "NotificationChannelPropertiesFragment": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "webHookUrl": { + "description": "The webhook URL to send notifications to.", + "type": "string" + }, + "description": { + "description": "Description of notification.", + "type": "string" + }, + "events": { + "description": "The list of event for which this notification is enabled.", + "type": "array", + "items": { "$ref": "#/definitions/EventFragment" } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "NotificationSettings": { + "description": "Notification settings for a schedule.", + "type": "object", + "properties": { + "status": { + "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStatus", + "modelAsString": true + } + }, + "timeInMinutes": { + "format": "int32", + "description": "Time in minutes before event at which notification will be sent.", + "type": "integer" + }, + "webhookUrl": { + "description": "The webhook URL to which the notification will be sent.", + "type": "string" + } + } + }, + "NotificationSettingsFragment": { + "description": "Notification settings for a schedule.", + "type": "object", + "properties": { + "status": { + "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationStatus", + "modelAsString": true + } + }, + "timeInMinutes": { + "format": "int32", + "description": "Time in minutes before event at which notification will be sent.", + "type": "integer" + }, + "webhookUrl": { + "description": "The webhook URL to which the notification will be sent.", + "type": "string" + } + } + }, + "NotifyParameters": { + "description": "Properties for generating a Notification.", + "type": "object", + "properties": { + "eventName": { + "description": "The type of event (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + }, + "jsonPayload": { + "description": "Properties for the notification in json format.", + "type": "string" + } + } + }, + "OperationError": { + "description": "Error details for the operation in case of a failure.", + "type": "object", + "properties": { + "code": { + "description": "The error code of the operation error.", + "type": "string" + }, + "message": { + "description": "The error message of the operation error.", + "type": "string" + } + } + }, + "OperationMetadata": { + "description": "The REST API operation supported by DevTestLab ResourceProvider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationMetadataDisplay", + "description": "The object that describes the operations" + } + } + }, + "OperationMetadataDisplay": { + "description": "The object that describes the operations", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + }, + "OperationResult": { + "description": "An Operation Result", + "type": "object", + "properties": { + "status": { + "description": "The operation status.", + "type": "string" + }, + "statusCode": { + "description": "The status code for the operation.", + "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "MovedPermanently", "Redirect", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], + "type": "string", + "x-ms-enum": { + "name": "HttpStatusCode", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/OperationError", + "description": "Error details for the operation in case of a failure." + } + } + }, + "ParameterInfo": { + "description": "Information about an artifact's parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ParametersValueFileInfo": { + "description": "A file containing a set of parameter values for an ARM template.", + "type": "object", + "properties": { + "fileName": { + "description": "File name.", + "type": "string" + }, + "parametersValueInfo": { + "description": "Contents of the file.", + "type": "object" + } + } + }, + "PercentageCostThresholdProperties": { + "description": "Properties of a percentage cost threshold.", + "type": "object", + "properties": { + "thresholdValue": { + "format": "double", + "description": "The cost threshold value.", + "type": "number" + } + } + }, + "Policy": { + "description": "A Policy.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "PolicyFragment": { + "description": "A Policy.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "PolicyProperties": { + "description": "Properties of a Policy.", + "type": "object", + "properties": { + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "status": { + "description": "The status of the policy.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + }, + "factName": { + "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", + "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyFactName", + "modelAsString": true + } + }, + "factData": { + "description": "The fact data of the policy.", + "type": "string" + }, + "threshold": { + "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", + "type": "string" + }, + "evaluatorType": { + "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", + "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyEvaluatorType", + "modelAsString": true + } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the policy.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "PolicyPropertiesFragment": { + "description": "Properties of a Policy.", + "type": "object", + "properties": { + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "status": { + "description": "The status of the policy.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + }, + "factName": { + "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", + "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyFactName", + "modelAsString": true + } + }, + "factData": { + "description": "The fact data of the policy.", + "type": "string" + }, + "threshold": { + "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", + "type": "string" + }, + "evaluatorType": { + "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", + "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyEvaluatorType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "PolicySetResult": { + "description": "Result of a policy set evaluation.", + "type": "object", + "properties": { + "hasError": { + "description": "A value indicating whether this policy set evaluation has discovered violations.", + "type": "boolean" + }, + "policyViolations": { + "description": "The list of policy violations.", + "type": "array", + "items": { "$ref": "#/definitions/PolicyViolation" } + } + } + }, + "PolicyViolation": { + "description": "Policy violation.", + "type": "object", + "properties": { + "code": { + "description": "The code of the policy violation.", + "type": "string" + }, + "message": { + "description": "The message of the policy violation.", + "type": "string" + } + } + }, + "Port": { + "description": "Properties of a network port.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "Protocol type of the port.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "backendPort": { + "format": "int32", + "description": "Backend port of the target virtual machine.", + "type": "integer" + } + } + }, + "PortFragment": { + "description": "Properties of a network port.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "Protocol type of the port.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "backendPort": { + "format": "int32", + "description": "Backend port of the target virtual machine.", + "type": "integer" + } + } + }, + "ProviderOperationResult": { + "description": "Result of the request to list REST API operations", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { "$ref": "#/definitions/OperationMetadata" } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "An Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + }, + "x-ms-azure-resource": true + }, + "ResponseWithContinuation[ArmTemplate]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ArmTemplate" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Artifact]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Artifact" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[ArtifactSource]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactSource" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[CustomImage]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/CustomImage" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Disk]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Disk" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[DtlEnvironment]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/DtlEnvironment" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Formula]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Formula" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[GalleryImage]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/GalleryImage" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Lab]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Lab" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[LabVhd]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/LabVhd" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[LabVirtualMachine]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[NotificationChannel]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/NotificationChannel" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Policy]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Policy" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Schedule]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Secret]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Secret" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[ServiceRunner]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ServiceRunner" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[User]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/User" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[VirtualNetwork]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/VirtualNetwork" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "RetargetScheduleProperties": { + "description": "Properties for retargeting a virtual machine schedule.", + "type": "object", + "properties": { + "currentResourceId": { + "description": "The resource Id of the virtual machine on which the schedule operates", + "type": "string" + }, + "targetResourceId": { + "description": "The resource Id of the virtual machine that the schedule should be retargeted to", + "type": "string" + } + } + }, + "Schedule": { + "description": "A schedule.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ScheduleProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ScheduleFragment": { + "description": "A schedule.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SchedulePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ScheduleProperties": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetails", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetails", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetails", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettings", + "description": "Notification settings." + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the schedule.", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "SchedulePropertiesFragment": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetailsFragment", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetailsFragment", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetailsFragment", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettingsFragment", + "description": "Notification settings." + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "Secret": { + "description": "A secret.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "SecretProperties": { + "description": "Properties of a secret.", + "type": "object", + "properties": { + "value": { + "description": "The value of the secret for secret creation.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "ServiceRunner": { + "description": "A container for a managed identity to execute DevTest lab services.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the resource." + } + } + }, + "SharedPublicIpAddressConfiguration": { + "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", + "type": "object", + "properties": { + "inboundNatRules": { + "description": "The incoming NAT rules", + "type": "array", + "items": { "$ref": "#/definitions/InboundNatRule" } + } + } + }, + "SharedPublicIpAddressConfigurationFragment": { + "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", + "type": "object", + "properties": { + "inboundNatRules": { + "description": "The incoming NAT rules", + "type": "array", + "items": { "$ref": "#/definitions/InboundNatRuleFragment" } + } + } + }, + "ShutdownNotificationContent": { + "description": "The contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown.", + "type": "object", + "properties": { + "skipUrl": { + "description": "The URL to skip auto-shutdown.", + "type": "string" + }, + "delayUrl60": { + "description": "The URL to delay shutdown by 60 minutes.", + "type": "string" + }, + "delayUrl120": { + "description": "The URL to delay shutdown by 2 hours.", + "type": "string" + }, + "vmName": { + "description": "The virtual machine to be shut down.", + "type": "string" + }, + "guid": { + "description": "The GUID for the virtual machine to be shut down.", + "type": "string" + }, + "owner": { + "description": "The owner of the virtual machine.", + "type": "string" + }, + "eventType": { + "description": "The event for which a notification will be sent.", + "type": "string" + }, + "text": { + "description": "The text for the notification.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription ID for the schedule.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name for the schedule.", + "type": "string" + }, + "labName": { + "description": "The lab for the schedule.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnet information.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name of the subnet as seen in the lab.", + "type": "string" + }, + "allowPublicIp": { + "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + } + } + }, + "SubnetFragment": { + "description": "Subnet information.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name of the subnet as seen in the lab.", + "type": "string" + }, + "allowPublicIp": { + "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + } + } + }, + "SubnetOverride": { + "description": "Property overrides on a subnet of a virtual network.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name given to the subnet within the lab.", + "type": "string" + }, + "useInVmCreationPermission": { + "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "usePublicIpAddressPermission": { + "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SubnetSharedPublicIpAddressConfiguration", + "description": "Properties that virtual machines on this subnet will share." + }, + "virtualNetworkPoolName": { + "description": "The virtual network pool associated with this subnet.", + "type": "string" + } + } + }, + "SubnetOverrideFragment": { + "description": "Property overrides on a subnet of a virtual network.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name given to the subnet within the lab.", + "type": "string" + }, + "useInVmCreationPermission": { + "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "usePublicIpAddressPermission": { + "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SubnetSharedPublicIpAddressConfigurationFragment", + "description": "Properties that virtual machines on this subnet will share." + }, + "virtualNetworkPoolName": { + "description": "The virtual network pool associated with this subnet.", + "type": "string" + } + } + }, + "SubnetSharedPublicIpAddressConfiguration": { + "description": "Configuration for public IP address sharing.", + "type": "object", + "properties": { + "allowedPorts": { + "description": "Backend ports that virtual machines on this subnet are allowed to expose", + "type": "array", + "items": { "$ref": "#/definitions/Port" } + } + } + }, + "SubnetSharedPublicIpAddressConfigurationFragment": { + "description": "Configuration for public IP address sharing.", + "type": "object", + "properties": { + "allowedPorts": { + "description": "Backend ports that virtual machines on this subnet are allowed to expose", + "type": "array", + "items": { "$ref": "#/definitions/PortFragment" } + } + } + }, + "TargetCostProperties": { + "description": "Properties of a cost target.", + "type": "object", + "properties": { + "status": { + "description": "Target cost status", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "TargetCostStatus", + "modelAsString": true + } + }, + "target": { + "format": "int32", + "description": "Lab target cost", + "type": "integer" + }, + "costThresholds": { + "description": "Cost thresholds.", + "type": "array", + "items": { "$ref": "#/definitions/CostThresholdProperties" } + }, + "cycleStartDateTime": { + "format": "date-time", + "description": "Reporting cycle start date.", + "type": "string" + }, + "cycleEndDateTime": { + "format": "date-time", + "description": "Reporting cycle end date.", + "type": "string" + }, + "cycleType": { + "description": "Reporting cycle type.", + "enum": [ "CalendarMonth", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ReportingCycleType", + "modelAsString": true + } + } + } + }, + "User": { + "description": "Profile of a lab user.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "UserFragment": { + "description": "Profile of a lab user.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "UserIdentity": { + "description": "Identity attributes of a lab user.", + "type": "object", + "properties": { + "principalName": { + "description": "Set to the principal name / UPN of the client JWT making the request.", + "type": "string" + }, + "principalId": { + "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", + "type": "string" + }, + "tenantId": { + "description": "Set to the tenant ID of the client JWT making the request.", + "type": "string" + }, + "objectId": { + "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", + "type": "string" + }, + "appId": { + "description": "Set to the app Id of the client JWT making the request.", + "type": "string" + } + } + }, + "UserIdentityFragment": { + "description": "Identity attributes of a lab user.", + "type": "object", + "properties": { + "principalName": { + "description": "Set to the principal name / UPN of the client JWT making the request.", + "type": "string" + }, + "principalId": { + "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", + "type": "string" + }, + "tenantId": { + "description": "Set to the tenant ID of the client JWT making the request.", + "type": "string" + }, + "objectId": { + "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", + "type": "string" + }, + "appId": { + "description": "Set to the app Id of the client JWT making the request.", + "type": "string" + } + } + }, + "UserProperties": { + "description": "Properties of a lab user profile.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/UserIdentity", + "description": "The identity of the user." + }, + "secretStore": { + "$ref": "#/definitions/UserSecretStore", + "description": "The secret store of the user." + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the user profile.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "UserPropertiesFragment": { + "description": "Properties of a lab user profile.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/UserIdentityFragment", + "description": "The identity of the user." + }, + "secretStore": { + "$ref": "#/definitions/UserSecretStoreFragment", + "description": "The secret store of the user." + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "UserSecretStore": { + "description": "Properties of a user's secret store.", + "type": "object", + "properties": { + "keyVaultUri": { + "description": "The URI of the user's Key vault.", + "type": "string" + }, + "keyVaultId": { + "description": "The ID of the user's Key vault.", + "type": "string" + } + } + }, + "UserSecretStoreFragment": { + "description": "Properties of a user's secret store.", + "type": "object", + "properties": { + "keyVaultUri": { + "description": "The URI of the user's Key vault.", + "type": "string" + }, + "keyVaultId": { + "description": "The ID of the user's Key vault.", + "type": "string" + } + } + }, + "VirtualNetwork": { + "description": "A virtual network.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkFragment": { + "description": "A virtual network.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkProperties": { + "description": "Properties of a virtual network.", + "type": "object", + "properties": { + "allowedSubnets": { + "description": "The allowed subnets of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/Subnet" } + }, + "description": { + "description": "The description of the virtual network.", + "type": "string" + }, + "externalProviderResourceId": { + "description": "The Microsoft.Network resource identifier of the virtual network.", + "type": "string" + }, + "externalSubnets": { + "description": "The external subnet properties.", + "type": "array", + "items": { "$ref": "#/definitions/ExternalSubnet" } + }, + "subnetOverrides": { + "description": "The subnet overrides of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetOverride" } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual network.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "VirtualNetworkPropertiesFragment": { + "description": "Properties of a virtual network.", + "type": "object", + "properties": { + "allowedSubnets": { + "description": "The allowed subnets of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetFragment" } + }, + "description": { + "description": "The description of the virtual network.", + "type": "string" + }, + "externalProviderResourceId": { + "description": "The Microsoft.Network resource identifier of the virtual network.", + "type": "string" + }, + "externalSubnets": { + "description": "The external subnet properties.", + "type": "array", + "items": { "$ref": "#/definitions/ExternalSubnetFragment" } + }, + "subnetOverrides": { + "description": "The subnet overrides of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetOverrideFragment" } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "WeekDetails": { + "description": "Properties of a weekly schedule.", + "type": "object", + "properties": { + "weekdays": { + "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", + "type": "array", + "items": { "type": "string" } + }, + "time": { + "description": "The time of the day the schedule will occur.", + "type": "string" + } + } + }, + "WeekDetailsFragment": { + "description": "Properties of a weekly schedule.", + "type": "object", + "properties": { + "weekdays": { + "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", + "type": "array", + "items": { "type": "string" } + }, + "time": { + "description": "The time of the day the schedule will occur.", + "type": "string" + } + } + }, + "WindowsOsInfo": { + "description": "Information about a Windows OS.", + "type": "object", + "properties": { + "windowsOsState": { + "description": "The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).", + "enum": [ "NonSysprepped", "SysprepRequested", "SysprepApplied" ], + "type": "string", + "x-ms-enum": { + "name": "WindowsOsState", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "Client API version.", + "required": true, + "type": "string", + "default": "2016-05-15" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The name of the location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "OAuth2 Implicit Grant", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { "user_impersonation": "Access Microsoft Azure" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json index bf8e4d00ffb8..91631e8e3741 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json @@ -1,434 +1,434 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications": { - "get": { - "tags": [ - "Applications" - ], - "description": "Lists all of the applications for the HDInsight cluster.", - "operationId": "Applications_List", - "x-ms-examples": { - "Get All Applications for an HDInsight cluster": { - "$ref": "./examples/GetAllApplications.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ApplicationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}": { - "get": { - "tags": [ - "Applications" - ], - "description": "Lists properties of the specified application.", - "operationId": "Applications_Get", - "x-ms-examples": { - "Get application on HDInsight cluster successfully created.": { - "$ref": "./examples/GetApplicationCreated.json" - }, - "Get application on HDInsight cluster creation in progress": { - "$ref": "./examples/GetApplicationInProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Application" - } - } - } - }, - "put": { - "tags": [ - "Applications" - ], - "description": "Creates applications for the HDInsight cluster.", - "operationId": "Applications_Create", - "x-ms-examples": { - "Create Application": { - "$ref": "./examples/CreateApplication.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Application" - }, - "description": "The application create request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Application" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Applications" - ], - "description": "Deletes the specified application on the HDInsight cluster.", - "operationId": "Applications_Delete", - "x-ms-examples": { - "Delete Application from HDInsight cluster": { - "$ref": "./examples/DeleteApplication.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApplicationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "ApplicationGetHttpsEndpoint": { - "description": "Gets the application HTTP endpoints.", - "type": "object", - "properties": { - "accessModes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of access modes for the application." - }, - "location": { - "type": "string", - "description": "The location of the endpoint." - }, - "destinationPort": { - "type": "integer", - "format": "int32", - "description": "The destination port to connect to." - }, - "publicPort": { - "type": "integer", - "format": "int32", - "description": "The public port to connect to." - } - }, - "additionalProperties": { - "type": "string" - } - }, - "ApplicationGetEndpoint": { - "description": "Gets the application SSH endpoint", - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location of the endpoint." - }, - "destinationPort": { - "type": "integer", - "format": "int32", - "description": "The destination port to connect to." - }, - "publicPort": { - "type": "integer", - "format": "int32", - "description": "The public port to connect to." - } - } - }, - "ApplicationProperties": { - "description": "The HDInsight cluster application GET response.", - "type": "object", - "properties": { - "computeProfile": { - "$ref": "./cluster.json#/definitions/ComputeProfile", - "description": "The list of roles in the cluster." - }, - "installScriptActions": { - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptAction" - }, - "description": "The list of install script actions." - }, - "uninstallScriptActions": { - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptAction" - }, - "description": "The list of uninstall script actions." - }, - "httpsEndpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGetHttpsEndpoint" - }, - "description": "The list of application HTTPS endpoints." - }, - "sshEndpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationGetEndpoint" - }, - "description": "The list of application SSH endpoints." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state of the application." - }, - "applicationType": { - "type": "string", - "description": "The application type." - }, - "applicationState": { - "readOnly": true, - "type": "string", - "description": "The application state." - }, - "errors": { - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/Errors" - }, - "description": "The list of errors." - }, - "createdDate": { - "readOnly": true, - "type": "string", - "description": "The application create date time." - }, - "marketplaceIdentifier": { - "readOnly": true, - "type": "string", - "description": "The marketplace identifier." - }, - "additionalProperties": { - "description": "The additional properties for application.", - "type": "string" - } - } - }, - "Application": { - "description": "The HDInsight cluster application", - "type": "object", - "allOf": [ - { - "$ref": "./cluster.json#/definitions/ProxyResource" - } - ], - "properties": { - "etag": { - "description": "The ETag for the application", - "type": "string" - }, - "tags": { - "description": "The tags for the application.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/ApplicationProperties", - "description": "The properties of the application." - } - } - }, - "ApplicationListResult": { - "description": "Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Application" - }, - "description": "The list of HDInsight applications installed on HDInsight cluster." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The URL to get the next set of operation list results if there are any." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ApplicationNameParameter": { - "name": "applicationName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the application name.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Applications" + ], + "description": "Lists all of the applications for the HDInsight cluster.", + "operationId": "Applications_List", + "x-ms-examples": { + "Get All Applications for an HDInsight cluster": { + "$ref": "./examples/GetAllApplications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Applications" + ], + "description": "Lists properties of the specified application.", + "operationId": "Applications_Get", + "x-ms-examples": { + "Get application on HDInsight cluster successfully created.": { + "$ref": "./examples/GetApplicationCreated.json" + }, + "Get application on HDInsight cluster creation in progress": { + "$ref": "./examples/GetApplicationInProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "description": "Creates applications for the HDInsight cluster.", + "operationId": "Applications_Create", + "x-ms-examples": { + "Create Application": { + "$ref": "./examples/CreateApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The application create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Applications" + ], + "description": "Deletes the specified application on the HDInsight cluster.", + "operationId": "Applications_Delete", + "x-ms-examples": { + "Delete Application from HDInsight cluster": { + "$ref": "./examples/DeleteApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicationGetHttpsEndpoint": { + "description": "Gets the application HTTP endpoints.", + "type": "object", + "properties": { + "accessModes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of access modes for the application." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to." + } + }, + "additionalProperties": { + "type": "string" + } + }, + "ApplicationGetEndpoint": { + "description": "Gets the application SSH endpoint", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to." + } + } + }, + "ApplicationProperties": { + "description": "The HDInsight cluster application GET response.", + "type": "object", + "properties": { + "computeProfile": { + "$ref": "./cluster.json#/definitions/ComputeProfile", + "description": "The list of roles in the cluster." + }, + "installScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "description": "The list of install script actions." + }, + "uninstallScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "description": "The list of uninstall script actions." + }, + "httpsEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetHttpsEndpoint" + }, + "description": "The list of application HTTPS endpoints." + }, + "sshEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetEndpoint" + }, + "description": "The list of application SSH endpoints." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the application." + }, + "applicationType": { + "type": "string", + "description": "The application type." + }, + "applicationState": { + "readOnly": true, + "type": "string", + "description": "The application state." + }, + "errors": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/Errors" + }, + "description": "The list of errors." + }, + "createdDate": { + "readOnly": true, + "type": "string", + "description": "The application create date time." + }, + "marketplaceIdentifier": { + "readOnly": true, + "type": "string", + "description": "The marketplace identifier." + }, + "additionalProperties": { + "description": "The additional properties for application.", + "type": "string" + } + } + }, + "Application": { + "description": "The HDInsight cluster application", + "type": "object", + "allOf": [ + { + "$ref": "./cluster.json#/definitions/ProxyResource" + } + ], + "properties": { + "etag": { + "description": "The ETag for the application", + "type": "string" + }, + "tags": { + "description": "The tags for the application.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties of the application." + } + } + }, + "ApplicationListResult": { + "description": "Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of HDInsight applications installed on HDInsight cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the application name.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json index 0bbe754530be..f1d97e1cf498 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json @@ -1,1162 +1,1162 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}": { - "put": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Create", - "description": "Creates a new HDInsight cluster with the specified parameters.", - "x-ms-examples": { - "Create Hadoop on Linux cluster with SSH password": { - "$ref": "./examples/CreateLinuxHadoopSshPassword.json" - }, - "Create Hadoop on Linux cluster with SSH public key": { - "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" - }, - "Create Spark on Linux Cluster with SSH password": { - "$ref": "./examples/CreateLinuxSparkSshPassword.json" - }, - "Create Secure Hadoop cluster": { - "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" - }, - "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { - "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterCreateParametersExtended" - }, - "description": "The cluster create request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Update", - "description": "Patch HDInsight cluster with the specified parameters.", - "x-ms-examples": { - "Patch HDInsight Linux clusters": { - "$ref": "./examples/PatchLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPatchParameters" - }, - "description": "The cluster patch request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - } - }, - "delete": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Delete", - "description": "Deletes the specified HDInsight cluster.", - "x-ms-examples": { - "Delete Hadoop on Linux cluster": { - "$ref": "./examples/DeleteLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "Accepted response definition." - }, - "200": { - "description": "Ok response definition." - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Get", - "description": "Gets the specified cluster.", - "x-ms-examples": { - "Get Hadoop on Linux cluster": { - "$ref": "./examples/GetLinuxHadoopCluster.json" - }, - "Get Spark on Linux cluster": { - "$ref": "./examples/GetLinuxSparkCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "description": "Lists the HDInsight clusters in a resource group.", - "x-ms-examples": { - "Get All Hadoop on Linux clusters in a resource group": { - "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Resize", - "description": "Resizes the specified HDInsight cluster to the specified size.", - "x-ms-examples": { - "Resize the worker nodes for a Hadoop on Linux cluster": { - "$ref": "./examples/ResizeLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "roleName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the roleName", - "enum": [ - "workernode" - ], - "x-ms-enum": { - "name": "RoleName", - "modelAsString": true - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterResizeParameters" - }, - "description": "The parameters for the resize operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_List", - "x-ms-examples": { - "Get All Hadoop on Linux clusters": { - "$ref": "./examples/GetLinuxHadoopAllClusters.json" - } - }, - "description": "Lists all the HDInsight clusters under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ClusterDefinition": { - "description": "The cluster definition.", - "properties": { - "blueprint": { - "type": "string", - "description": "The link to the blueprint." - }, - "kind": { - "type": "string", - "description": "The type of cluster." - }, - "componentVersion": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The versions of different services in the cluster." - }, - "configurations": { - "type": "object", - "description": "The cluster configurations." - } - } - }, - "SecurityProfile": { - "description": "The security profile which contains Ssh public key for the HDInsight cluster.", - "properties": { - "directoryType": { - "type": "string", - "description": "The directory type.", - "enum": [ - "ActiveDirectory" - ], - "x-ms-enum": { - "name": "DirectoryType", - "modelAsString": false - } - }, - "domain": { - "type": "string", - "description": "The organization's active directory domain." - }, - "organizationalUnitDN": { - "type": "string", - "description": "The organizational unit within the Active Directory to place the cluster and service accounts." - }, - "ldapsUrls": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The LDAPS protocol URLs to communicate with the Active Directory." - }, - "domainUsername": { - "type": "string", - "description": "The domain user account that will have admin privileges on the cluster." - }, - "domainUserPassword": { - "type": "string", - "format": "password", - "description": "The domain admin password." - }, - "clusterUsersGroupDNs": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. The Distinguished Names for cluster user groups" - } - } - }, - "HardwareProfile": { - "properties": { - "vmSize": { - "type": "string", - "description": "The size of the VM" - } - }, - "description": "The hardware profile." - }, - "VirtualNetworkProfile": { - "description": "The virtual network properties.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the virtual network." - }, - "subnet": { - "type": "string", - "description": "The name of the subnet." - } - } - }, - "DataDisksGroups": { - "description": "The data disks groups for the role.", - "properties": { - "disksPerNode": { - "type": "integer", - "format": "int32", - "description": "The number of disks per node." - }, - "storageAccountType": { - "type": "string", - "description": "ReadOnly. The storage account type. Do not set this value.", - "readOnly": true - }, - "diskSizeGB": { - "type": "integer", - "description": "ReadOnly. The DiskSize in GB. Do not set this value.", - "readOnly": true - } - } - }, - "SshPublicKey": { - "description": "The SSH public key for the cluster nodes.", - "properties": { - "certificateData": { - "type": "string", - "description": "The certificate for SSH." - } - } - }, - "SshProfile": { - "description": "The list of SSH public keys.", - "properties": { - "publicKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - }, - "description": "The list of SSH public keys." - } - } - }, - "LinuxOperatingSystemProfile": { - "description": "The ssh username, password, and ssh public key.", - "properties": { - "username": { - "type": "string", - "description": "The username." - }, - "password": { - "type": "string", - "description": "The password." - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile", - "description": "The SSH profile." - } - } - }, - "OsProfile": { - "description": "The Linux operation systems profile.", - "properties": { - "linuxOperatingSystemProfile": { - "$ref": "#/definitions/LinuxOperatingSystemProfile", - "description": "The Linux OS profile." - } - } - }, - "Role": { - "properties": { - "name": { - "type": "string", - "description": "The name of the role." - }, - "minInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The minimum instance count of the cluster." - }, - "targetInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The instance count of the cluster." - }, - "hardwareProfile": { - "$ref": "#/definitions/HardwareProfile", - "description": "The hardware profile." - }, - "osProfile": { - "$ref": "#/definitions/OsProfile", - "description": "The operating system profile." - }, - "virtualNetworkProfile": { - "$ref": "#/definitions/VirtualNetworkProfile", - "description": "The virtual network profile." - }, - "dataDisksGroups": { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisksGroups" - }, - "description": "The data disks groups for the role." - }, - "scriptActions": { - "type": "array", - "items": { - "$ref": "./scriptActions.json#/definitions/ScriptAction" - }, - "description": "The list of script actions on the role." - } - }, - "description": "Describes a role on the cluster." - }, - "ComputeProfile": { - "properties": { - "roles": { - "type": "array", - "items": { - "$ref": "#/definitions/Role" - }, - "description": "The list of roles in the cluster." - } - }, - "description": "Describes the compute profile." - }, - "StorageAccount": { - "properties": { - "name": { - "type": "string", - "description": "The name of the storage account." - }, - "isDefault": { - "type": "boolean", - "description": "Whether or not the storage account is the default storage account." - }, - "container": { - "type": "string", - "description": "The container in the storage account, only to be specified for WASB storage accounts." - }, - "fileSystem": { - "type": "string", - "description": "The filesystem, only to be specified for Azure Data Lake Storage Gen 2." - }, - "key": { - "type": "string", - "description": "The storage account access key." - } - }, - "description": "The storage Account." - }, - "StorageProfile": { - "properties": { - "storageaccounts": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "The list of storage accounts in the cluster." - } - }, - "description": "The storage profile." - }, - "ClusterCreateProperties": { - "description": "The cluster create parameters.", - "properties": { - "clusterVersion": { - "type": "string", - "description": "The version of the cluster." - }, - "osType": { - "type": "string", - "description": "The type of operating system.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OSType", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The cluster tier.", - "enum": [ - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "Tier", - "modelAsString": false - } - }, - "clusterDefinition": { - "$ref": "#/definitions/ClusterDefinition", - "description": "The cluster definition." - }, - "securityProfile": { - "$ref": "#/definitions/SecurityProfile", - "description": "The security profile." - }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfile", - "description": "The compute profile." - }, - "storageProfile": { - "$ref": "#/definitions/StorageProfile", - "description": "The storage profile." - } - } - }, - "ClusterCreateParametersExtended": { - "properties": { - "location": { - "type": "string", - "description": "The location of the cluster." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - }, - "properties": { - "$ref": "#/definitions/ClusterCreateProperties", - "description": "The cluster create parameters." - } - }, - "description": "The CreateCluster request parameters." - }, - "ClusterPatchParameters": { - "properties": { - "tags": { - "type": "object", - "x-nullable": true, - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - } - }, - "description": "The PatchCluster request parameters" - }, - "QuotaInfo": { - "description": "The quota properties for the cluster.", - "properties": { - "coresUsed": { - "type": "integer", - "format": "int32", - "description": "The cores used by the cluster." - } - } - }, - "Errors": { - "description": "The error message associated with the cluster creation.", - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - } - }, - "ConnectivityEndpoint": { - "description": "The connectivity properties", - "properties": { - "name": { - "type": "string", - "description": "The name of the endpoint." - }, - "protocol": { - "type": "string", - "description": "The protocol of the endpoint." - }, - "location": { - "type": "string", - "description": "The location of the endpoint." - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The port to connect to." - } - } - }, - "ClusterGetProperties": { - "description": "The properties of cluster.", - "properties": { - "clusterVersion": { - "type": "string", - "description": "The version of the cluster." - }, - "osType": { - "type": "string", - "description": "The type of operating system.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OSType", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The cluster tier.", - "enum": [ - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "Tier", - "modelAsString": false - } - }, - "clusterDefinition": { - "$ref": "#/definitions/ClusterDefinition", - "description": "The cluster definition." - }, - "securityProfile": { - "$ref": "#/definitions/SecurityProfile", - "description": "The security profile." - }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfile", - "description": "The compute profile." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state, which only appears in the response.", - "enum": [ - "InProgress", - "Failed", - "Succeeded", - "Canceled", - "Deleting" - ], - "x-ms-enum": { - "name": "HDInsightClusterProvisioningState", - "modelAsString": false - } - }, - "createdDate": { - "type": "string", - "description": "The date on which the cluster was created." - }, - "clusterState": { - "type": "string", - "description": "The state of the cluster." - }, - "quotaInfo": { - "$ref": "#/definitions/QuotaInfo", - "description": "The quota information." - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/Errors" - }, - "description": "The list of errors." - }, - "connectivityEndpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectivityEndpoint" - }, - "description": "The list of connectivity endpoints." - } - }, - "required": [ - "clusterDefinition" - ] - }, - "Cluster": { - "allOf": [{ - "$ref": "#/definitions/TrackedResource" - }], - "properties": { - "etag": { - "type": "string", - "description": "The ETag for the resource" - }, - "properties": { - "$ref": "#/definitions/ClusterGetProperties", - "description": "The properties of the cluster." - } - }, - "description": "The HDInsight cluster." - }, - "RuntimeScriptAction": { - "properties": { - "name": { - "type": "string", - "description": "The name of the script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script" - }, - "roles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of roles where script will be executed." - }, - "applicationName": { - "readOnly": true, - "type": "string", - "description": "The application name of the script action, if any." - } - }, - "required": [ - "name", - "uri", - "roles" - ], - "description": "Describes a script action on a running cluster." - }, - "ExecuteScriptActionParameters": { - "properties": { - "scriptActions": { - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptAction" - }, - "description": "The list of run time script actions." - }, - "persistOnSuccess": { - "type": "boolean", - "description": "Gets or sets if the scripts needs to be persisted." - } - }, - "required": [ - "persistOnSuccess" - ], - "description": "The parameters for the script actions to execute on a running cluster." - }, - "ClusterListPersistedScriptActionsResult": { - "properties": { - "value": { - "description": "The list of Persisted Script Actions.", - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptAction" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The ListPersistedScriptActions operation response." - }, - "ScriptActionExecutionSummary": { - "properties": { - "status": { - "readOnly": true, - "type": "string", - "description": "The status of script action execution." - }, - "instanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The instance count for a given script action execution status." - } - }, - "description": "The execution summary of a script action." - }, - "RuntimeScriptActionDetail": { - "allOf": [ - { - "$ref": "#/definitions/RuntimeScriptAction" - }, - { - "properties": { - "scriptExecutionId": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The execution id of the script action." - }, - "startTime": { - "readOnly": true, - "type": "string", - "description": "The start time of script action execution." - }, - "endTime": { - "readOnly": true, - "type": "string", - "description": "The end time of script action execution." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "The current execution status of the script action." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "The reason why the script action was executed." - }, - "executionSummary": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ScriptActionExecutionSummary" - }, - "description": "The summary of script action execution result." - }, - "debugInformation": { - "readOnly": true, - "type": "string", - "description": "The script action execution debug information." - } - } - } - ], - "description": "The execution details of a script action." - }, - "ClusterListRuntimeScriptActionDetailResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptActionDetail" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The list runtime script action detail response." - }, - "ClusterListResult": { - "properties": { - "value": { - "description": "The list of Clusters.", - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The List Cluster operation response." - }, - "ClusterResizeParameters": { - "properties": { - "targetInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The target instance count for the operation." - } - }, - "description": "The Resize Cluster request parameters." - }, - "OperationResource": { - "properties": { - "status": { - "type": "string", - "description": "The async operation state.", - "enum": [ - "InProgress", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "AsyncOperationState", - "modelAsString": false - } - }, - "error": { - "$ref": "#/definitions/Errors", - "description": "The operation error information." - } - }, - "description": "The azure async operation response." - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "description": "Creates a new HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Create Hadoop on Linux cluster with SSH password": { + "$ref": "./examples/CreateLinuxHadoopSshPassword.json" + }, + "Create Hadoop on Linux cluster with SSH public key": { + "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" + }, + "Create Spark on Linux Cluster with SSH password": { + "$ref": "./examples/CreateLinuxSparkSshPassword.json" + }, + "Create Secure Hadoop cluster": { + "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" + }, + "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { + "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateParametersExtended" + }, + "description": "The cluster create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "description": "Patch HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Patch HDInsight Linux clusters": { + "$ref": "./examples/PatchLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + }, + "description": "The cluster patch request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "description": "Deletes the specified HDInsight cluster.", + "x-ms-examples": { + "Delete Hadoop on Linux cluster": { + "$ref": "./examples/DeleteLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "Ok response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "description": "Gets the specified cluster.", + "x-ms-examples": { + "Get Hadoop on Linux cluster": { + "$ref": "./examples/GetLinuxHadoopCluster.json" + }, + "Get Spark on Linux cluster": { + "$ref": "./examples/GetLinuxSparkCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "description": "Lists the HDInsight clusters in a resource group.", + "x-ms-examples": { + "Get All Hadoop on Linux clusters in a resource group": { + "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Resize", + "description": "Resizes the specified HDInsight cluster to the specified size.", + "x-ms-examples": { + "Resize the worker nodes for a Hadoop on Linux cluster": { + "$ref": "./examples/ResizeLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the roleName", + "enum": [ + "workernode" + ], + "x-ms-enum": { + "name": "RoleName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResizeParameters" + }, + "description": "The parameters for the resize operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "Get All Hadoop on Linux clusters": { + "$ref": "./examples/GetLinuxHadoopAllClusters.json" + } + }, + "description": "Lists all the HDInsight clusters under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ClusterDefinition": { + "description": "The cluster definition.", + "properties": { + "blueprint": { + "type": "string", + "description": "The link to the blueprint." + }, + "kind": { + "type": "string", + "description": "The type of cluster." + }, + "componentVersion": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The versions of different services in the cluster." + }, + "configurations": { + "type": "object", + "description": "The cluster configurations." + } + } + }, + "SecurityProfile": { + "description": "The security profile which contains Ssh public key for the HDInsight cluster.", + "properties": { + "directoryType": { + "type": "string", + "description": "The directory type.", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "DirectoryType", + "modelAsString": false + } + }, + "domain": { + "type": "string", + "description": "The organization's active directory domain." + }, + "organizationalUnitDN": { + "type": "string", + "description": "The organizational unit within the Active Directory to place the cluster and service accounts." + }, + "ldapsUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The LDAPS protocol URLs to communicate with the Active Directory." + }, + "domainUsername": { + "type": "string", + "description": "The domain user account that will have admin privileges on the cluster." + }, + "domainUserPassword": { + "type": "string", + "format": "password", + "description": "The domain admin password." + }, + "clusterUsersGroupDNs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The Distinguished Names for cluster user groups" + } + } + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "The size of the VM" + } + }, + "description": "The hardware profile." + }, + "VirtualNetworkProfile": { + "description": "The virtual network properties.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the virtual network." + }, + "subnet": { + "type": "string", + "description": "The name of the subnet." + } + } + }, + "DataDisksGroups": { + "description": "The data disks groups for the role.", + "properties": { + "disksPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of disks per node." + }, + "storageAccountType": { + "type": "string", + "description": "ReadOnly. The storage account type. Do not set this value.", + "readOnly": true + }, + "diskSizeGB": { + "type": "integer", + "description": "ReadOnly. The DiskSize in GB. Do not set this value.", + "readOnly": true + } + } + }, + "SshPublicKey": { + "description": "The SSH public key for the cluster nodes.", + "properties": { + "certificateData": { + "type": "string", + "description": "The certificate for SSH." + } + } + }, + "SshProfile": { + "description": "The list of SSH public keys.", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys." + } + } + }, + "LinuxOperatingSystemProfile": { + "description": "The ssh username, password, and ssh public key.", + "properties": { + "username": { + "type": "string", + "description": "The username." + }, + "password": { + "type": "string", + "description": "The password." + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile", + "description": "The SSH profile." + } + } + }, + "OsProfile": { + "description": "The Linux operation systems profile.", + "properties": { + "linuxOperatingSystemProfile": { + "$ref": "#/definitions/LinuxOperatingSystemProfile", + "description": "The Linux OS profile." + } + } + }, + "Role": { + "properties": { + "name": { + "type": "string", + "description": "The name of the role." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster." + }, + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The instance count of the cluster." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "The hardware profile." + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The operating system profile." + }, + "virtualNetworkProfile": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "The virtual network profile." + }, + "dataDisksGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisksGroups" + }, + "description": "The data disks groups for the role." + }, + "scriptActions": { + "type": "array", + "items": { + "$ref": "./scriptActions.json#/definitions/ScriptAction" + }, + "description": "The list of script actions on the role." + } + }, + "description": "Describes a role on the cluster." + }, + "ComputeProfile": { + "properties": { + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The list of roles in the cluster." + } + }, + "description": "Describes the compute profile." + }, + "StorageAccount": { + "properties": { + "name": { + "type": "string", + "description": "The name of the storage account." + }, + "isDefault": { + "type": "boolean", + "description": "Whether or not the storage account is the default storage account." + }, + "container": { + "type": "string", + "description": "The container in the storage account, only to be specified for WASB storage accounts." + }, + "fileSystem": { + "type": "string", + "description": "The filesystem, only to be specified for Azure Data Lake Storage Gen 2." + }, + "key": { + "type": "string", + "description": "The storage account access key." + } + }, + "description": "The storage Account." + }, + "StorageProfile": { + "properties": { + "storageaccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The list of storage accounts in the cluster." + } + }, + "description": "The storage profile." + }, + "ClusterCreateProperties": { + "description": "The cluster create parameters.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile." + } + } + }, + "ClusterCreateParametersExtended": { + "properties": { + "location": { + "type": "string", + "description": "The location of the cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "properties": { + "$ref": "#/definitions/ClusterCreateProperties", + "description": "The cluster create parameters." + } + }, + "description": "The CreateCluster request parameters." + }, + "ClusterPatchParameters": { + "properties": { + "tags": { + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "description": "The PatchCluster request parameters" + }, + "QuotaInfo": { + "description": "The quota properties for the cluster.", + "properties": { + "coresUsed": { + "type": "integer", + "format": "int32", + "description": "The cores used by the cluster." + } + } + }, + "Errors": { + "description": "The error message associated with the cluster creation.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ConnectivityEndpoint": { + "description": "The connectivity properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "protocol": { + "type": "string", + "description": "The protocol of the endpoint." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port to connect to." + } + } + }, + "ClusterGetProperties": { + "description": "The properties of cluster.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "HDInsightClusterProvisioningState", + "modelAsString": false + } + }, + "createdDate": { + "type": "string", + "description": "The date on which the cluster was created." + }, + "clusterState": { + "type": "string", + "description": "The state of the cluster." + }, + "quotaInfo": { + "$ref": "#/definitions/QuotaInfo", + "description": "The quota information." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Errors" + }, + "description": "The list of errors." + }, + "connectivityEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityEndpoint" + }, + "description": "The list of connectivity endpoints." + } + }, + "required": [ + "clusterDefinition" + ] + }, + "Cluster": { + "allOf": [{ + "$ref": "#/definitions/TrackedResource" + }], + "properties": { + "etag": { + "type": "string", + "description": "The ETag for the resource" + }, + "properties": { + "$ref": "#/definitions/ClusterGetProperties", + "description": "The properties of the cluster." + } + }, + "description": "The HDInsight cluster." + }, + "RuntimeScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "readOnly": true, + "type": "string", + "description": "The application name of the script action, if any." + } + }, + "required": [ + "name", + "uri", + "roles" + ], + "description": "Describes a script action on a running cluster." + }, + "ExecuteScriptActionParameters": { + "properties": { + "scriptActions": { + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + }, + "description": "The list of run time script actions." + }, + "persistOnSuccess": { + "type": "boolean", + "description": "Gets or sets if the scripts needs to be persisted." + } + }, + "required": [ + "persistOnSuccess" + ], + "description": "The parameters for the script actions to execute on a running cluster." + }, + "ClusterListPersistedScriptActionsResult": { + "properties": { + "value": { + "description": "The list of Persisted Script Actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The ListPersistedScriptActions operation response." + }, + "ScriptActionExecutionSummary": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of script action execution." + }, + "instanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The instance count for a given script action execution status." + } + }, + "description": "The execution summary of a script action." + }, + "RuntimeScriptActionDetail": { + "allOf": [ + { + "$ref": "#/definitions/RuntimeScriptAction" + }, + { + "properties": { + "scriptExecutionId": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The execution id of the script action." + }, + "startTime": { + "readOnly": true, + "type": "string", + "description": "The start time of script action execution." + }, + "endTime": { + "readOnly": true, + "type": "string", + "description": "The end time of script action execution." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The current execution status of the script action." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The reason why the script action was executed." + }, + "executionSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ScriptActionExecutionSummary" + }, + "description": "The summary of script action execution result." + }, + "debugInformation": { + "readOnly": true, + "type": "string", + "description": "The script action execution debug information." + } + } + } + ], + "description": "The execution details of a script action." + }, + "ClusterListRuntimeScriptActionDetailResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The list runtime script action detail response." + }, + "ClusterListResult": { + "properties": { + "value": { + "description": "The list of Clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The List Cluster operation response." + }, + "ClusterResizeParameters": { + "properties": { + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The target instance count for the operation." + } + }, + "description": "The Resize Cluster request parameters." + }, + "OperationResource": { + "properties": { + "status": { + "type": "string", + "description": "The async operation state.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationState", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/Errors", + "description": "The operation error information." + } + }, + "description": "The azure async operation response." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json index 12bb5e526c61..09c1205c711c 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json @@ -1,189 +1,189 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { - "post": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_UpdateHTTPSettings", - "description": "Configures the HTTP settings on the specified cluster.", - "x-ms-examples": { - "Enable HTTP connectivity": { - "$ref": "./examples/ChangeHttpConnectivityEnable.json" - }, - "Disable HTTP connectivity": { - "$ref": "./examples/ChangeHttpConnectivityDisable.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - }, - "description": "The cluster configurations." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition" - }, - "202": { - "description": "Accepted response definition" - }, - "204": { - "description": "No content response definition" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Get", - "description": "The configuration object for the specified cluster.", - "x-ms-examples": { - "Get HTTP settings": { - "$ref": "./examples/GetHttpConnectivity.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - } - } - } - } - } - }, - "definitions": { - "ClusterConfiguration": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The configuration object for the specified configuration for the specified cluster." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ConfigurationNameParameter": { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster configuration.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_UpdateHTTPSettings", + "description": "Configures the HTTP settings on the specified cluster.", + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityEnable.json" + }, + "Disable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityDisable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition" + }, + "202": { + "description": "Accepted response definition" + }, + "204": { + "description": "No content response definition" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "description": "The configuration object for the specified cluster.", + "x-ms-examples": { + "Get HTTP settings": { + "$ref": "./examples/GetHttpConnectivity.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + } + } + } + }, + "definitions": { + "ClusterConfiguration": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The configuration object for the specified configuration for the specified cluster." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster configuration.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityDisable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityDisable.json index 10dc9291bb9d..7b8aa50a0c4a 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityDisable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityDisable.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway", - "parameters": { - "restAuthCredential.isEnabled": "false" - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {}, - "204": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "false" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityEnable.json index 21e708525b29..8e89a6dcedcd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityEnable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ChangeHttpConnectivityEnable.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway", - "parameters": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {}, - "204": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json index 6738a1fe6424..a2e6a005e2c5 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateExtension.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring", - "parameters": { - "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", - "primaryKey": "**********" - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json index b4724a8aea53..950b1f1e844c 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateLinuxHadoopAdlsGen2.json @@ -1,88 +1,88 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.6", - "osType": "Linux", - "tier": "Standard", - "clusterDefinition": { - "kind": "Hadoop", - "configurations": { - "gateway": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "admin", - "restAuthCredential.password": "**********" - } - } - }, - "storageProfile": { - "storageaccounts": [ - { - "name": "mystorage.dfs.core.windows.net", - "isDefault": true, - "fileSystem": "default", - "key": "storagekey" - } - ] - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "minInstanceCount": 1, - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - }, - { - "name": "workernode", - "minInstanceCount": 1, - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - }, - { - "name": "zookeepernode", - "minInstanceCount": 1, - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Small" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - } - ] - } - } - } - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.dfs.core.windows.net", + "isDefault": true, + "fileSystem": "default", + "key": "storagekey" + } + ] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json index 101d3c534ced..c3420b135d9d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteApplication.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "applicationName": "hue", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "202": {} - } +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json index e9e9d2486215..23cf9dfbfc8f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteExtension.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring" - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteLinuxHadoopCluster.json index d1ee5cccf872..21199f5eed71 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteLinuxHadoopCluster.json @@ -1,12 +1,12 @@ - { - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "202": {}, - "200": {} - } + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteScriptAction.json index 421d2718dcb5..d473e618ccde 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DeleteScriptAction.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "scriptName": "scriptName" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "scriptName": "scriptName" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json index 4ee49f8033ca..24ceb6f88437 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/DisableLinuxClusterMonitoring.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json index 049991d352a2..f4d256257be3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/EnableLinuxClusterMonitoring.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", - "primaryKey": "**********" - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetAllApplications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetAllApplications.json index ee7aaeb3d3bb..a04714bc0d68 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetAllApplications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetAllApplications.json @@ -1,89 +1,89 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D12_v2" - } - }] - }, - "installScriptActions": [{ - "name": "app-install-app", - "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "https://cluster1-app.apps.azurehdinsight.net:443", - "destinationPort": 20000, - "publicPort": 443 - }], - "sshEndpoints": [{ - "location": "app.cluster1-ssh.azurehdinsight.net:22", - "destinationPort": 22, - "publicPort": 22 - }], - "provisioningState": "Succeeded", - "applicationState": "Running", - "createdDate": "2017-03-22T21:34:39.293", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" - } - }, { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", - "name": "app2", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D3" - } - }] - }, - "installScriptActions": [{ - "name": "app2-Install", - "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "location", - "destinationPort": 18630, - "publicPort": 443 - }], - "sshEndpoints": [], - "provisioningState": "InProgress", - "applicationState": "AzureVMConfiguration", - "createdDate": "2017-03-28T02:01:25.107", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" - } - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install-app", + "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1-app.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "app.cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" + } + }, { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", + "name": "app2", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app2-Install", + "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationCreated.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationCreated.json index 42c0dda789ff..8bc4a4ba8220 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationCreated.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationCreated.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "applicationName": "app", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D12_v2" - } - }] - }, - "installScriptActions": [{ - "name": "app-install", - "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "https://cluster1.apps.azurehdinsight.net:443", - "destinationPort": 20000, - "publicPort": 443 - }], - "sshEndpoints": [{ - "location": "cluster1-ssh.azurehdinsight.net:22", - "destinationPort": 22, - "publicPort": 22 - }], - "provisioningState": "Succeeded", - "applicationState": "Running", - "createdDate": "2017-03-22T21:34:39.293", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "appMarketId" - } - } - } - } +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install", + "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "appMarketId" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationInProgress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationInProgress.json index bd94b57821b4..f38cdeb185b3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationInProgress.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetApplicationInProgress.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "applicationName": "app", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D3" - } - }] - }, - "installScriptActions": [{ - "name": "app-Install", - "uri": "https://app.com/azure/app_install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "location", - "destinationPort": 18630, - "publicPort": 443 - }], - "sshEndpoints": [], - "provisioningState": "InProgress", - "applicationState": "AzureVMConfiguration", - "createdDate": "2017-03-28T02:01:25.107", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "id" - } - } - } - } +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "id" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetExtension.json index 0fb5da4969ac..191b907bb728 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetExtension.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightCapabilities.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightCapabilities.json index df951c140d04..09acae7a3231 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightCapabilities.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightCapabilities.json @@ -1,3236 +1,3236 @@ -{ - "parameters": { - "location": "West US", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "Body": { - "versions": { - "paas": { - "available": [{ - "friendlyName": "1.6", - "displayName": "HdInsight version 1.6.1.0.335536", - "isDefault": false - }, - { - "friendlyName": "2.1", - "displayName": "Version 2.1.9.406.1221105", - "isDefault": false, - "componentVersions": { - "HDP": "1.3", - "Hadoop": "1.2.0" - } - }, - { - "friendlyName": "3.0", - "displayName": "Version 3.0.6.989.2441725", - "isDefault": false, - "componentVersions": { - "HDP": "2.0", - "Hadoop": "2.2.0" - } - }, - { - "friendlyName": "3.1", - "displayName": "Version 3.1.4.989.2441725", - "isDefault": false, - "componentVersions": { - "HDP": "2.1.7", - "Hadoop": "2.4.0", - "HBase": "0.98" - } - }, - { - "friendlyName": "3.2", - "displayName": "Version 3.2.7.989.2441725", - "isDefault": false, - "componentVersions": { - "HDP": "2.2", - "Hadoop": "2.6.0", - "HBase": "0.98.4", - "Storm": "0.9.3" - } - }, - { - "friendlyName": "3.3", - "displayName": "Version 3.3.0.989.2441725", - "isDefault": true, - "componentVersions": { - "HDP": "2.3", - "Hadoop": "2.7.0", - "HBase": "1.1.2", - "Storm": "0.10.0" - } - } - ] - }, - "iaas": { - "available": [{ - "friendlyName": "3.2", - "displayName": "Version 3.2.1000.0.8840373", - "isDefault": false, - "componentVersions": { - "HDP": "2.2", - "Hadoop": "2.6.0", - "HBase": "0.98.4", - "Storm": "0.9.3" - } - }, - { - "friendlyName": "3.3", - "displayName": "Version 3.3.1000.0.9776961", - "isDefault": false, - "componentVersions": { - "HDP": "2.3", - "Hadoop": "2.7.0", - "HBase": "1.1.2", - "Storm": "0.10.0", - "Spark": "1.5.2" - } - }, - { - "friendlyName": "3.4", - "displayName": "Version 3.4.1000.0.9719475", - "isDefault": false, - "componentVersions": { - "HDP": "2.4", - "Hadoop": "2.7.1", - "HBase": "1.1.2", - "Storm": "0.10.0", - "Spark": "1.6.2", - "RServer": "8.0" - } - }, - { - "friendlyName": "3.5", - "displayName": "Version 3.5.1000.0.9732704", - "isDefault": true, - "componentVersions": { - "HDP": "2.5", - "Hadoop": "2.7.3", - "InteractiveHive": "2.1.0", - "HBase": "1.1.2", - "Storm": "1.0.1", - "Spark": "1.6.3,2.0.2", - "RServer": "9.0" - } - }, - { - "friendlyName": "3.6", - "displayName": "Version 3.6.1000.0.9503998", - "isDefault": false, - "componentVersions": { - "HDP": "2.6", - "Spark": "2.1.0" - } - }, - { - "friendlyName": "99.152", - "displayName": "Version 99.152.1000.0.6943836", - "isDefault": false - } - ] - } - }, - "regions": { - "paas": { - "available": [ - "AUSTRALIA EAST", - "AUSTRALIA SOUTHEAST", - "BRAZIL SOUTH", - "CENTRAL INDIA", - "CENTRAL US", - "EAST ASIA", - "EAST US", - "EAST US 2", - "JAPAN EAST", - "JAPAN WEST", - "NORTH CENTRAL US", - "NORTH EUROPE", - "SOUTH CENTRAL US", - "SOUTHEAST ASIA", - "WEST EUROPE", - "WEST US", - "WEST US 2" - ] - }, - "iaas": { - "available": [ - "AUSTRALIA EAST", - "AUSTRALIA SOUTHEAST", - "BRAZIL SOUTH", - "CANADA CENTRAL", - "CANADA EAST", - "CENTRAL INDIA", - "CENTRAL US", - "CENTRAL US EUAP", - "EAST ASIA", - "EAST US", - "EAST US 2", - "JAPAN EAST", - "JAPAN WEST", - "NORTH CENTRAL US", - "NORTH EUROPE", - "SOUTH CENTRAL US", - "SOUTHEAST ASIA", - "WEST CENTRAL US", - "WEST EUROPE", - "WEST US", - "WEST US 2" - ] - } - }, - "vmsizes": { - "paas": { - "available": [ - "A5", - "A6", - "A7", - "EXTRALARGE", - "LARGE", - "MEDIUM", - "SMALL", - "STANDARD_D1", - "STANDARD_D1_V2", - "STANDARD_D11", - "STANDARD_D11_V2", - "STANDARD_D12", - "STANDARD_D12_V2", - "STANDARD_D13", - "STANDARD_D13_V2", - "STANDARD_D14", - "STANDARD_D14_V2", - "STANDARD_D2", - "STANDARD_D2_V2", - "STANDARD_D3", - "STANDARD_D3_V2", - "STANDARD_D4", - "STANDARD_D4_V2", - "STANDARD_D5_V2" - ] - }, - "iaas": { - "available": [ - "A5", - "A6", - "A7", - "EXTRALARGE", - "LARGE", - "MEDIUM", - "SMALL", - "STANDARD_D1", - "STANDARD_D1_V2", - "STANDARD_D11", - "STANDARD_D11_V2", - "STANDARD_D12", - "STANDARD_D12_V2", - "STANDARD_D13", - "STANDARD_D13_V2", - "STANDARD_D14", - "STANDARD_D14_V2", - "STANDARD_D2", - "STANDARD_D2_V2", - "STANDARD_D3", - "STANDARD_D3_V2", - "STANDARD_D4", - "STANDARD_D4_V2", - "STANDARD_D5_V2" - ] - } - }, - "vmsize_filters": [{ - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A5" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A5" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A5" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A5" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A5" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A6" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A6" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A6" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A6" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A7" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A7" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A7" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "A7" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "EXTRALARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "EXTRALARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "WorkerNodeRole", - "EdgeNodeRole", - "ZookeeperRole" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "EXTRALARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "EXTRALARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "LARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "LARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "LARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "LARGE" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "MEDIUM" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "MEDIUM" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "MEDIUM" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "SMALL" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "SMALL" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "HBase", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "SMALL" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "SMALL" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole", - "EdgeNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Sandbox" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D5_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "Hadoop", - "Spark" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D5_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "Brazil South", - "Japan West" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D5_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "*" - ], - "ClusterVersions": [ - "1.6", - "2.1", - "3.0" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D5_V2" - ] - }, - { - "FilterMode": "Exclude", - "Regions": [ - "*" - ], - "ClusterFlavors": [ - "InteractiveHive" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D5_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D1_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D11_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D12_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D13_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D14_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D2_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D3_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "*" - ], - "NodeTypes": [ - "HeadNodeRole", - "WorkerNodeRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - }, - { - "FilterMode": "Include", - "Regions": [ - "Central India" - ], - "ClusterFlavors": [ - "HBase", - "Storm" - ], - "NodeTypes": [ - "ZookeeperRole" - ], - "ClusterVersions": [ - "*" - ], - "OsType": [ - "*" - ], - "VMSizes": [ - "STANDARD_D4_V2" - ] - } - ], - "features": [ - "ALLOW_GATEWAY_AUTH_BYPASS", - "AUX_IAAS_FUNCTIONALITIES", - "BLOCK_APPS_FOR_SECURE_CLUSTER", - "CLUSTER_RESIZE", - "CLUSTERS_CONTRACT_1", - "CLUSTERS_CONTRACT_1_SDK", - "CLUSTERS_CONTRACT_2_SDK", - "CLUSTERS_CONTRACT_VERSION_3_SDK", - "COLLECTANONYMIZEDLOGS", - "CONTAINER_LOG_COLLECTOR", - "CONTAINER_RESOURCE_V3", - "CUSTOM_ACTIONS_V2", - "DATALAKE", - "DATALAKE_3_2", - "DATALAKE_3_4", - "DATALAKE_3_5", - "DATALAKE_DEFAULTFS_3_5", - "DEFAULT_CONTAINER_IDENTIFIER_AND_STORAGEFQDN_ALREADY_USED", - "DOCUMENT_VALIDATION_IN_API", - "ENABLEDATALAKE", - "ENABLEGENEVAANALYTICS", - "HADOOP_VIRTUAL_NETWORK_ENABLED", - "HS2_ZK_ROUTER_INTERACTIVEHIVE", - "IAAS_ALLOW_CUSTOM_DNS", - "IAAS_AMBARI_APP_TIMELINE_SERVER_HA_SERVICE", - "IAAS_AMBARI_DEPENDENCY_BASED_DEPLOYMENT", - "IAAS_AMBARI_HA_SERVICES", - "IAAS_AMBARI_HISTORYSERVER_HA_SERVICE", - "IAAS_AMBARI_LOWER_LATENCY", - "IAAS_AMBARI_SKIP_COMPONENTS_INSTALL", - "IAAS_ARM_PROVISIONING", - "IAAS_CLOSE_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", - "IAAS_CLUSTER_APPLICATION_ALLOW_MULTIPLE_ROLE_INSTANCES", - "IAAS_CLUSTER_APPLICATION_REMOVE", - "IAAS_CLUSTER_CONTAINER_PREUPLOAD_SUBMIT_WAIT", - "IAAS_CLUSTER_RSERVER", - "IAAS_DB_CREATION_IN_PARALLEL_TO_VM", - "IAAS_DELETE_LEAKED_RESOURCES", - "IAAS_DEPLOYMENTS", - "IAAS_DO_NOT_CREATE_WASB_TABLES_IN_CUSTOMER_STORAGE", - "IAAS_ENABLE_CLUSTER_CONFIG_OVERRIDES", - "IAAS_ENABLE_OFFLINE_CLEANUP", - "IAAS_ENABLE_OFFLINE_CLEANUP_FOR_DELETING_VMS", - "IAAS_INCLUDE_STORAGE_IN_SUBSCRIPTION_SELECTION", - "IAAS_PARALLEL_DB_CREATE", - "IAAS_PREPROVISION_METASTORES_SCHEMAS", - "IAAS_SCRIPTACTIONS_DELETE_VMS_CRUD_FAILURES", - "IAAS_SCRIPTACTIONS_RUNNING", - "IAAS_SHORT_VM_NAME", - "IAAS_SUBMIT_AMBARI_REQUEST_ONCE_LINUX_VM_ARE_AVAILABLE", - "IAAS_TEZ_ATS_V15", - "IAAS_USE_UNATTENDED_UPGRADES_FOR_PATCHING", - "IAAS_VALIDATE_CUSTOM_VNET", - "IAAS_VALIDATE_NSG", - "IAAS_WAIT_FOR_CLOSING_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", - "IAAS_YARN_HDINSIGHT_SQL_TIMELINE_STORE", - "IAAS_YARN_HDINSIGHT_TIMELINE_STORE", - "INTERACTIVEHIVE", - "MDSCENTRALLOGGING", - "NODE_SETUP_POLLER_ENABLED", - "OVERPROVISION_HOSTGROUP_edgenode", - "OVERPROVISION_HOSTGROUP_Gateway", - "OVERPROVISION_HOSTGROUP_Workernode", - "OVERPROVISION_HOSTGROUP_zookeepernode", - "PERF_OPTIMIZED_RESOURCE_LOCATION_FETCH", - "PORTALAPPINSTALL", - "POWERSHELL_SCRIPT_ACTION", - "POWERSHELL_SCRIPT_ACTION_SDK", - "PREMIUM_TIER_PREVIEW", - "PROVISIONING_AGENT", - "RMHA", - "RSERVER_CLUSTERTYPE_3_5_ENABLED", - "RSERVER_CLUSTERTYPE_ENABLED", - "SHOW_HUMBOLDT_GA", - "SHOW_IBIZA_CREATE", - "SPARK_2_1", - "SPARK_EXPERIMENTAL", - "STORM_PREVIEW", - "UI_CREATE_WIZARD_V2", - "VIRTUAL_NETWORK_ENABLED", - "VMSIZES_AUX" - ], - "quota": { - "cores_used": 72, - "max_cores_allowed": 1000, - "regionalQuotas": [{ - "region_name": "Australia East", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Australia Southeast", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Brazil South", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Canada Central", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Canada East", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Central India", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Central US", - "cores_used": 24, - "cores_available": 1000 - }, - { - "region_name": "Central US EUAP", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "East Asia", - "cores_used": 24, - "cores_available": 1000 - }, - { - "region_name": "East US", - "cores_used": 24, - "cores_available": 1000 - }, - { - "region_name": "East US 2", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Japan East", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Japan West", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "North Central US", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "North Europe", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "South Central US", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "Southeast Asia", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "West Central US", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "West Europe", - "cores_used": 0, - "cores_available": 1000 - }, - { - "region_name": "West US", - "cores_used": 132, - "cores_available": 1000 - }, - { - "region_name": "West US 2", - "cores_used": 0, - "cores_available": 1000 - } - ] - } - } - } - } +{ + "parameters": { + "location": "West US", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "Body": { + "versions": { + "paas": { + "available": [{ + "friendlyName": "1.6", + "displayName": "HdInsight version 1.6.1.0.335536", + "isDefault": false + }, + { + "friendlyName": "2.1", + "displayName": "Version 2.1.9.406.1221105", + "isDefault": false, + "componentVersions": { + "HDP": "1.3", + "Hadoop": "1.2.0" + } + }, + { + "friendlyName": "3.0", + "displayName": "Version 3.0.6.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.0", + "Hadoop": "2.2.0" + } + }, + { + "friendlyName": "3.1", + "displayName": "Version 3.1.4.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.1.7", + "Hadoop": "2.4.0", + "HBase": "0.98" + } + }, + { + "friendlyName": "3.2", + "displayName": "Version 3.2.7.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.2", + "Hadoop": "2.6.0", + "HBase": "0.98.4", + "Storm": "0.9.3" + } + }, + { + "friendlyName": "3.3", + "displayName": "Version 3.3.0.989.2441725", + "isDefault": true, + "componentVersions": { + "HDP": "2.3", + "Hadoop": "2.7.0", + "HBase": "1.1.2", + "Storm": "0.10.0" + } + } + ] + }, + "iaas": { + "available": [{ + "friendlyName": "3.2", + "displayName": "Version 3.2.1000.0.8840373", + "isDefault": false, + "componentVersions": { + "HDP": "2.2", + "Hadoop": "2.6.0", + "HBase": "0.98.4", + "Storm": "0.9.3" + } + }, + { + "friendlyName": "3.3", + "displayName": "Version 3.3.1000.0.9776961", + "isDefault": false, + "componentVersions": { + "HDP": "2.3", + "Hadoop": "2.7.0", + "HBase": "1.1.2", + "Storm": "0.10.0", + "Spark": "1.5.2" + } + }, + { + "friendlyName": "3.4", + "displayName": "Version 3.4.1000.0.9719475", + "isDefault": false, + "componentVersions": { + "HDP": "2.4", + "Hadoop": "2.7.1", + "HBase": "1.1.2", + "Storm": "0.10.0", + "Spark": "1.6.2", + "RServer": "8.0" + } + }, + { + "friendlyName": "3.5", + "displayName": "Version 3.5.1000.0.9732704", + "isDefault": true, + "componentVersions": { + "HDP": "2.5", + "Hadoop": "2.7.3", + "InteractiveHive": "2.1.0", + "HBase": "1.1.2", + "Storm": "1.0.1", + "Spark": "1.6.3,2.0.2", + "RServer": "9.0" + } + }, + { + "friendlyName": "3.6", + "displayName": "Version 3.6.1000.0.9503998", + "isDefault": false, + "componentVersions": { + "HDP": "2.6", + "Spark": "2.1.0" + } + }, + { + "friendlyName": "99.152", + "displayName": "Version 99.152.1000.0.6943836", + "isDefault": false + } + ] + } + }, + "regions": { + "paas": { + "available": [ + "AUSTRALIA EAST", + "AUSTRALIA SOUTHEAST", + "BRAZIL SOUTH", + "CENTRAL INDIA", + "CENTRAL US", + "EAST ASIA", + "EAST US", + "EAST US 2", + "JAPAN EAST", + "JAPAN WEST", + "NORTH CENTRAL US", + "NORTH EUROPE", + "SOUTH CENTRAL US", + "SOUTHEAST ASIA", + "WEST EUROPE", + "WEST US", + "WEST US 2" + ] + }, + "iaas": { + "available": [ + "AUSTRALIA EAST", + "AUSTRALIA SOUTHEAST", + "BRAZIL SOUTH", + "CANADA CENTRAL", + "CANADA EAST", + "CENTRAL INDIA", + "CENTRAL US", + "CENTRAL US EUAP", + "EAST ASIA", + "EAST US", + "EAST US 2", + "JAPAN EAST", + "JAPAN WEST", + "NORTH CENTRAL US", + "NORTH EUROPE", + "SOUTH CENTRAL US", + "SOUTHEAST ASIA", + "WEST CENTRAL US", + "WEST EUROPE", + "WEST US", + "WEST US 2" + ] + } + }, + "vmsizes": { + "paas": { + "available": [ + "A5", + "A6", + "A7", + "EXTRALARGE", + "LARGE", + "MEDIUM", + "SMALL", + "STANDARD_D1", + "STANDARD_D1_V2", + "STANDARD_D11", + "STANDARD_D11_V2", + "STANDARD_D12", + "STANDARD_D12_V2", + "STANDARD_D13", + "STANDARD_D13_V2", + "STANDARD_D14", + "STANDARD_D14_V2", + "STANDARD_D2", + "STANDARD_D2_V2", + "STANDARD_D3", + "STANDARD_D3_V2", + "STANDARD_D4", + "STANDARD_D4_V2", + "STANDARD_D5_V2" + ] + }, + "iaas": { + "available": [ + "A5", + "A6", + "A7", + "EXTRALARGE", + "LARGE", + "MEDIUM", + "SMALL", + "STANDARD_D1", + "STANDARD_D1_V2", + "STANDARD_D11", + "STANDARD_D11_V2", + "STANDARD_D12", + "STANDARD_D12_V2", + "STANDARD_D13", + "STANDARD_D13_V2", + "STANDARD_D14", + "STANDARD_D14_V2", + "STANDARD_D2", + "STANDARD_D2_V2", + "STANDARD_D3", + "STANDARD_D3_V2", + "STANDARD_D4", + "STANDARD_D4_V2", + "STANDARD_D5_V2" + ] + } + }, + "vmsize_filters": [{ + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A5" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A5" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A5" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A5" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A5" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A6" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A6" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A6" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A6" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A7" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A7" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A7" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "A7" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "EXTRALARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "EXTRALARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "WorkerNodeRole", + "EdgeNodeRole", + "ZookeeperRole" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "EXTRALARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "EXTRALARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "LARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "LARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "LARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "LARGE" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "MEDIUM" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "MEDIUM" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "MEDIUM" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "SMALL" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "SMALL" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "HBase", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "SMALL" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "SMALL" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole", + "EdgeNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Sandbox" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D5_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "Hadoop", + "Spark" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D5_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "Brazil South", + "Japan West" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D5_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "*" + ], + "ClusterVersions": [ + "1.6", + "2.1", + "3.0" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D5_V2" + ] + }, + { + "FilterMode": "Exclude", + "Regions": [ + "*" + ], + "ClusterFlavors": [ + "InteractiveHive" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D5_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D1_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D11_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D12_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D13_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D14_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D2_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D3_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "*" + ], + "NodeTypes": [ + "HeadNodeRole", + "WorkerNodeRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + }, + { + "FilterMode": "Include", + "Regions": [ + "Central India" + ], + "ClusterFlavors": [ + "HBase", + "Storm" + ], + "NodeTypes": [ + "ZookeeperRole" + ], + "ClusterVersions": [ + "*" + ], + "OsType": [ + "*" + ], + "VMSizes": [ + "STANDARD_D4_V2" + ] + } + ], + "features": [ + "ALLOW_GATEWAY_AUTH_BYPASS", + "AUX_IAAS_FUNCTIONALITIES", + "BLOCK_APPS_FOR_SECURE_CLUSTER", + "CLUSTER_RESIZE", + "CLUSTERS_CONTRACT_1", + "CLUSTERS_CONTRACT_1_SDK", + "CLUSTERS_CONTRACT_2_SDK", + "CLUSTERS_CONTRACT_VERSION_3_SDK", + "COLLECTANONYMIZEDLOGS", + "CONTAINER_LOG_COLLECTOR", + "CONTAINER_RESOURCE_V3", + "CUSTOM_ACTIONS_V2", + "DATALAKE", + "DATALAKE_3_2", + "DATALAKE_3_4", + "DATALAKE_3_5", + "DATALAKE_DEFAULTFS_3_5", + "DEFAULT_CONTAINER_IDENTIFIER_AND_STORAGEFQDN_ALREADY_USED", + "DOCUMENT_VALIDATION_IN_API", + "ENABLEDATALAKE", + "ENABLEGENEVAANALYTICS", + "HADOOP_VIRTUAL_NETWORK_ENABLED", + "HS2_ZK_ROUTER_INTERACTIVEHIVE", + "IAAS_ALLOW_CUSTOM_DNS", + "IAAS_AMBARI_APP_TIMELINE_SERVER_HA_SERVICE", + "IAAS_AMBARI_DEPENDENCY_BASED_DEPLOYMENT", + "IAAS_AMBARI_HA_SERVICES", + "IAAS_AMBARI_HISTORYSERVER_HA_SERVICE", + "IAAS_AMBARI_LOWER_LATENCY", + "IAAS_AMBARI_SKIP_COMPONENTS_INSTALL", + "IAAS_ARM_PROVISIONING", + "IAAS_CLOSE_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", + "IAAS_CLUSTER_APPLICATION_ALLOW_MULTIPLE_ROLE_INSTANCES", + "IAAS_CLUSTER_APPLICATION_REMOVE", + "IAAS_CLUSTER_CONTAINER_PREUPLOAD_SUBMIT_WAIT", + "IAAS_CLUSTER_RSERVER", + "IAAS_DB_CREATION_IN_PARALLEL_TO_VM", + "IAAS_DELETE_LEAKED_RESOURCES", + "IAAS_DEPLOYMENTS", + "IAAS_DO_NOT_CREATE_WASB_TABLES_IN_CUSTOMER_STORAGE", + "IAAS_ENABLE_CLUSTER_CONFIG_OVERRIDES", + "IAAS_ENABLE_OFFLINE_CLEANUP", + "IAAS_ENABLE_OFFLINE_CLEANUP_FOR_DELETING_VMS", + "IAAS_INCLUDE_STORAGE_IN_SUBSCRIPTION_SELECTION", + "IAAS_PARALLEL_DB_CREATE", + "IAAS_PREPROVISION_METASTORES_SCHEMAS", + "IAAS_SCRIPTACTIONS_DELETE_VMS_CRUD_FAILURES", + "IAAS_SCRIPTACTIONS_RUNNING", + "IAAS_SHORT_VM_NAME", + "IAAS_SUBMIT_AMBARI_REQUEST_ONCE_LINUX_VM_ARE_AVAILABLE", + "IAAS_TEZ_ATS_V15", + "IAAS_USE_UNATTENDED_UPGRADES_FOR_PATCHING", + "IAAS_VALIDATE_CUSTOM_VNET", + "IAAS_VALIDATE_NSG", + "IAAS_WAIT_FOR_CLOSING_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", + "IAAS_YARN_HDINSIGHT_SQL_TIMELINE_STORE", + "IAAS_YARN_HDINSIGHT_TIMELINE_STORE", + "INTERACTIVEHIVE", + "MDSCENTRALLOGGING", + "NODE_SETUP_POLLER_ENABLED", + "OVERPROVISION_HOSTGROUP_edgenode", + "OVERPROVISION_HOSTGROUP_Gateway", + "OVERPROVISION_HOSTGROUP_Workernode", + "OVERPROVISION_HOSTGROUP_zookeepernode", + "PERF_OPTIMIZED_RESOURCE_LOCATION_FETCH", + "PORTALAPPINSTALL", + "POWERSHELL_SCRIPT_ACTION", + "POWERSHELL_SCRIPT_ACTION_SDK", + "PREMIUM_TIER_PREVIEW", + "PROVISIONING_AGENT", + "RMHA", + "RSERVER_CLUSTERTYPE_3_5_ENABLED", + "RSERVER_CLUSTERTYPE_ENABLED", + "SHOW_HUMBOLDT_GA", + "SHOW_IBIZA_CREATE", + "SPARK_2_1", + "SPARK_EXPERIMENTAL", + "STORM_PREVIEW", + "UI_CREATE_WIZARD_V2", + "VIRTUAL_NETWORK_ENABLED", + "VMSIZES_AUX" + ], + "quota": { + "cores_used": 72, + "max_cores_allowed": 1000, + "regionalQuotas": [{ + "region_name": "Australia East", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Australia Southeast", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Brazil South", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Canada Central", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Canada East", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Central India", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Central US", + "cores_used": 24, + "cores_available": 1000 + }, + { + "region_name": "Central US EUAP", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "East Asia", + "cores_used": 24, + "cores_available": 1000 + }, + { + "region_name": "East US", + "cores_used": 24, + "cores_available": 1000 + }, + { + "region_name": "East US 2", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Japan East", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Japan West", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "North Central US", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "North Europe", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "South Central US", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "Southeast Asia", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "West Central US", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "West Europe", + "cores_used": 0, + "cores_available": 1000 + }, + { + "region_name": "West US", + "cores_used": 132, + "cores_available": 1000 + }, + { + "region_name": "West US 2", + "cores_used": 0, + "cores_available": 1000 + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json index 015cb4e48d2e..68fbc33350fd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHDInsightUsages.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "location": "West US", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "Body": { - "value": [ - { - "unit": "Count", - "currentValue": 0, - "limit": 5000, - "name": { - "value": "cores", - "localizedValue": "Cores" - } - } - ] - } - } - } +{ + "parameters": { + "location": "West US", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "Body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 5000, + "name": { + "value": "cores", + "localizedValue": "Cores" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHttpConnectivity.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHttpConnectivity.json index 26033736edd0..b1cd3fce056a 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHttpConnectivity.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetHttpConnectivity.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway" - }, - "responses": { - "200": { - "body": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway" + }, + "responses": { + "200": { + "body": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxClusterMonitoringStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxClusterMonitoringStatus.json index a566a5388d20..507bfc92bbe2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxClusterMonitoringStatus.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxClusterMonitoringStatus.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClusters.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClusters.json index 10d2697b2ca9..abcbe733f1cd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClusters.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClusters.json @@ -1,163 +1,163 @@ - { - "parameters": { - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", - "name": "cluster2", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster2-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster2.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - ] - } - } - } + { + "parameters": { + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json index d9647b46bae6..48cbe1a1603b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json @@ -1,164 +1,164 @@ - { - "parameters": { - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", - "name": "cluster2", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster2-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster2.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - ] - } - } - } + { + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopCluster.json index 5cf7ef0bd59d..e5e7f1c75fad 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopCluster.json @@ -1,87 +1,87 @@ - { - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - } - } + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptAction.json index eb07e80c7e7f..27492e68ac99 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptAction.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "name": "app-Install", - "uri": "https://app.com/azure/app_install.sh", - "parameters": "", - "roles": ["edgenode"], - "applicationName": "app" - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "parameters": "", + "roles": ["edgenode"], + "applicationName": "app" + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json index 8ead93315fbd..c587ce3094b1 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "scriptExecutionId": 386120808773799, - "name": "app-install", - "applicationName": "app", - "uri": "http://app.com/public/hdi-app/20170301/hdinsight-app-install.sh", - "parameters": "", - "roles": [ - "edgenode" - ], - "startTime": "2017-03-22T21:40:37.8865514Z", - "endTime": "2017-03-22T22:06:02.1584639Z", - "status": "Succeeded", - "operation": "AppInstall", - "executionSummary": [{ - "status": "COMPLETED", - "instanceCount": 1 - }] - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 386120808773799, + "name": "app-install", + "applicationName": "app", + "uri": "http://app.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "parameters": "", + "roles": [ + "edgenode" + ], + "startTime": "2017-03-22T21:40:37.8865514Z", + "endTime": "2017-03-22T22:06:02.1584639Z", + "status": "Succeeded", + "operation": "AppInstall", + "executionSummary": [{ + "status": "COMPLETED", + "instanceCount": 1 + }] + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxSparkCluster.json index 41bce37d4458..e02cc1d8e1cf 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxSparkCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetLinuxSparkCluster.json @@ -1,90 +1,90 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", - "kind": "SPARK", - "componentVersion": { - "Spark": "2.0" - } - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D12_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D4_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-03-03T08:35:07.323", - "quotaInfo": { - "coresUsed": 40 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", + "kind": "SPARK", + "componentVersion": { + "Spark": "2.0" + } + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-03-03T08:35:07.323", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptActionById.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptActionById.json index 295274810010..85fb0180b9fc 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptActionById.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptActionById.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": { - "body": { - "scriptExecutionId": 391145124054712, - "name": "Test", - "applicationName": "app1", - "uri": "http://testurl.com/install.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [], - "debugInformation": "" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [], + "debugInformation": "" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptExecutionHistory.json index 915ab142370c..14b6dc679565 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptExecutionHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/GetScriptExecutionHistory.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": { - "body": { - "value": [{ - "scriptExecutionId": 391145124054712, - "name": "Test", - "applicationName": "app1", - "uri": "http://testurl.com/install.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [] - }, - { - "scriptExecutionId": 391144597342127, - "name": "Test", - "applicationName": "app2", - "uri": "http://testurl.com/install-script.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [] - } - ] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + }, + { + "scriptExecutionId": 391144597342127, + "name": "Test", + "applicationName": "app2", + "uri": "http://testurl.com/install-script.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PostExecuteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PostExecuteScriptAction.json index ab31f0a35332..c8cdc8fef116 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PostExecuteScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PostExecuteScriptAction.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "scriptActions": [{ - "name": "Test", - "uri": "http://testurl.com/install.ssh", - "roles": [ - "headnode", - "workernode" - ], - "parameters": "" - }], - "persistOnSuccess": false - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "scriptActions": [{ + "name": "Test", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "parameters": "" + }], + "persistOnSuccess": false + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PromoteLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PromoteLinuxHadoopScriptAction.json index 418fbc48acfd..ba46241244e6 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PromoteLinuxHadoopScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/PromoteLinuxHadoopScriptAction.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RdpSettingsEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RdpSettingsEnable.json index d9c130239a81..6b8758922685 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RdpSettingsEnable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RdpSettingsEnable.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "osProfile": { - "windowsOperatingSystemProfile": { - "rdpSettings": { - "username": "hadoop", - "password": "**********", - "expiryDate": "2017-02-28" - } - } - } - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "osProfile": { + "windowsOperatingSystemProfile": { + "rdpSettings": { + "username": "hadoop", + "password": "**********", + "expiryDate": "2017-02-28" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ResizeLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ResizeLinuxHadoopCluster.json index 4bad750f3af0..06b99f9c5afd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ResizeLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/ResizeLinuxHadoopCluster.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "roleName": "workernode", - "parameters": { - "targetInstanceCount": 10 - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "targetInstanceCount": 10 + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json index a35b2f9f6407..500fe6904b56 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json @@ -1,391 +1,391 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring": { - "put": { - "tags": [ - "Extensions" - ], - "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/EnableLinuxClusterMonitoring.json" - } - }, - "operationId": "Extension_EnableMonitoring", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterMonitoringRequest" - }, - "description": "The Operations Management Suite (OMS) workspace parameters." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Extensions" - ], - "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" - } - }, - "operationId": "Extension_GetMonitoringStatus", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ClusterMonitoringResponse" - } - } - } - }, - "delete": { - "tags": [ - "Extensions" - ], - "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/DisableLinuxClusterMonitoring.json" - } - }, - "operationId": "Extension_DisableMonitoring", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "OK response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { - "put": { - "tags": [ - "Extensions" - ], - "description": "Creates an HDInsight cluster extension.", - "operationId": "Extension_Create", - "x-ms-examples": { - "Create a monitoring extension on Hadoop Linux cluster": { - "$ref": "./examples/CreateExtension.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Extension" - }, - "description": "The cluster extensions create request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded." - }, - "202": { - "description": "OK. The request has succeeded." - } - } - }, - "get": { - "tags": [ - "Extensions" - ], - "description": "Gets the extension properties for the specified HDInsight cluster extension.", - "x-ms-examples": { - "Get an extension": { - "$ref": "./examples/GetExtension.json" - } - }, - "operationId": "Extension_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Extension" - } - } - } - }, - "delete": { - "tags": [ - "Extensions" - ], - "description": "Deletes the specified extension for HDInsight cluster.", - "x-ms-examples": { - "Delete an extension": { - "$ref": "./examples/DeleteExtension.json" - } - }, - "operationId": "Extension_Delete", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "OK response definition." - } - } - } - } - }, - "definitions": { - "Extension": { - "description": "Cluster monitoring extensions", - "properties": { - "workspaceId": { - "description": "The workspace ID for the cluster monitoring extension.", - "type": "string" - }, - "primaryKey": { - "description": "The certificate for the cluster monitoring extensions.", - "type": "string" - } - } - }, - "ClusterMonitoringResponse": { - "description": "The Operations Management Suite (OMS) status response", - "properties": { - "clusterMonitoringEnabled": { - "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", - "type": "boolean" - }, - "workspaceId": { - "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", - "type": "string" - } - } - }, - "ClusterMonitoringRequest": { - "description": "The Operations Management Suite (OMS) parameters.", - "properties": { - "workspaceId": { - "description": "The Operations Management Suite (OMS) workspace ID.", - "type": "string" - }, - "primaryKey": { - "description": "The Operations Management Suite (OMS) workspace key.", - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ExtensionNameParameter": { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster extension.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/EnableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extension_EnableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMonitoringRequest" + }, + "description": "The Operations Management Suite (OMS) workspace parameters." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" + } + }, + "operationId": "Extension_GetMonitoringStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClusterMonitoringResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/DisableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extension_DisableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Creates an HDInsight cluster extension.", + "operationId": "Extension_Create", + "x-ms-examples": { + "Create a monitoring extension on Hadoop Linux cluster": { + "$ref": "./examples/CreateExtension.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "The cluster extensions create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "OK. The request has succeeded." + } + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the extension properties for the specified HDInsight cluster extension.", + "x-ms-examples": { + "Get an extension": { + "$ref": "./examples/GetExtension.json" + } + }, + "operationId": "Extension_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Extension" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Deletes the specified extension for HDInsight cluster.", + "x-ms-examples": { + "Delete an extension": { + "$ref": "./examples/DeleteExtension.json" + } + }, + "operationId": "Extension_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Cluster monitoring extensions", + "properties": { + "workspaceId": { + "description": "The workspace ID for the cluster monitoring extension.", + "type": "string" + }, + "primaryKey": { + "description": "The certificate for the cluster monitoring extensions.", + "type": "string" + } + } + }, + "ClusterMonitoringResponse": { + "description": "The Operations Management Suite (OMS) status response", + "properties": { + "clusterMonitoringEnabled": { + "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "boolean" + }, + "workspaceId": { + "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "string" + } + } + }, + "ClusterMonitoringRequest": { + "description": "The Operations Management Suite (OMS) parameters.", + "properties": { + "workspaceId": { + "description": "The Operations Management Suite (OMS) workspace ID.", + "type": "string" + }, + "primaryKey": { + "description": "The Operations Management Suite (OMS) workspace key.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster extension.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json index fa4b6acbf035..e9bf4180cdf5 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json @@ -1,365 +1,365 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-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.HDInsight/locations/{location}/capabilities": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Locations_GetCapabilities", - "description": "Gets the capabilities for the specified location.", - "x-ms-examples": { - "Get the subscription capabilities for specific location": { - "$ref": "./examples/GetHDInsightCapabilities.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/CapabilitiesResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Locations_ListUsages", - "description": "Lists the usages for the specified location.", - "x-ms-examples": { - "Get the subscription usages for specific location": { - "$ref": "./examples/GetHDInsightUsages.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/UsagesListResult" - } - } - } - } - } - }, - "definitions": { - "VersionSpec": { - "description": "The version properties.", - "properties": { - "friendlyName": { - "type": "string", - "description": "The friendly name" - }, - "displayName": { - "type": "string", - "description": "The display name" - }, - "isDefault": { - "type": "string", - "description": "Whether or not the version is the default version." - }, - "componentVersions": { - "type": "object", - "description": "The component version property.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "VersionsCapability": { - "description": "The version capability.", - "properties": { - "available": { - "description": "The list of version capabilities.", - "type": "array", - "items": { - "$ref": "#/definitions/VersionSpec" - } - } - } - }, - "RegionsCapability": { - "description": "The regions capability.", - "properties": { - "available": { - "description": "The list of region capabilities.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "VmSizesCapability": { - "description": "The virtual machine sizes capability.", - "properties": { - "available": { - "description": "The list of virtual machine size capabilities.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "VmSizeCompatibilityFilter": { - "description": "The virtual machine type compatibility filter.", - "properties": { - "FilterMode": { - "description": "The mode for the filter.", - "type": "string" - }, - "Regions": { - "description": "The list of regions.", - "type": "array", - "items": { - "type": "string" - } - }, - "ClusterFlavors": { - "description": "The list of cluster types available.", - "type": "array", - "items": { - "type": "string" - } - }, - "NodeTypes": { - "description": "The list of node types.", - "type": "array", - "items": { - "type": "string" - } - }, - "ClusterVersions": { - "description": "The list of cluster versions.", - "type": "array", - "items": { - "type": "string" - } - }, - "vmsizes": { - "description": "The list of virtual machine sizes.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "RegionalQuotaCapability": { - "description": "The regional quota capacity.", - "properties": { - "region_name": { - "description": "The region name.", - "type": "string" - }, - "cores_used": { - "description": "The number of cores used in the region.", - "type": "integer", - "format": "int64" - }, - "cores_available": { - "description": "The number of courses available in the region.", - "type": "integer", - "format": "int64" - } - } - }, - "QuotaCapability": { - "description": "The regional quota capability.", - "properties": { - "regionalQuotas": { - "description": "The list of region quota capabilities.", - "type": "array", - "items": { - "$ref": "#/definitions/RegionalQuotaCapability" - } - } - } - }, - "CapabilitiesResult": { - "description": "The Get Capabilities operation response.", - "properties": { - "versions": { - "description": "The version capability.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/VersionsCapability" - } - }, - "regions": { - "description": "The virtual machine size compatibilty features.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/RegionsCapability" - } - }, - "vmSizes": { - "description": "The virtual machine sizes.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/VmSizesCapability" - } - }, - "vmSize_filters": { - "description": "The virtual machine size compatibilty filters.", - "type": "array", - "items": { - "$ref": "#/definitions/VmSizeCompatibilityFilter" - } - }, - "features": { - "description": "The capabilty features.", - "type": "array", - "items": { - "type": "string" - } - }, - "quota": { - "description": "The quota capability.", - "$ref": "#/definitions/QuotaCapability" - } - } - }, - "LocalizedName": { - "description": "The details about the localizable name of a type of usage.", - "properties": { - "value": { - "description": "The name of the used resource.", - "type": "string" - }, - "localizedValue": { - "description": "The localized name of the used resource.", - "type": "string" - } - } - }, - "Usage": { - "description": "The details about the usage of a particular limited resource.", - "properties": { - "unit": { - "description": "The type of measurement for usage.", - "type": "string" - }, - "currentValue": { - "description": "The current usage.", - "type": "integer" - }, - "limit": { - "description": "The maximum allowed usage.", - "type": "integer" - }, - "name": { - "description": "The details about the localizable name of the used resource.", - "$ref": "#/definitions/LocalizedName" - } - } - }, - "UsagesListResult": { - "description": "The response for the operation to get regional usages for a subscription.", - "properties": { - "value": { - "description": "The list of usages.", - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "LocationParameter": { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-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.HDInsight/locations/{location}/capabilities": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_GetCapabilities", + "description": "Gets the capabilities for the specified location.", + "x-ms-examples": { + "Get the subscription capabilities for specific location": { + "$ref": "./examples/GetHDInsightCapabilities.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/CapabilitiesResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListUsages", + "description": "Lists the usages for the specified location.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/GetHDInsightUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + } + } + } + }, + "definitions": { + "VersionSpec": { + "description": "The version properties.", + "properties": { + "friendlyName": { + "type": "string", + "description": "The friendly name" + }, + "displayName": { + "type": "string", + "description": "The display name" + }, + "isDefault": { + "type": "string", + "description": "Whether or not the version is the default version." + }, + "componentVersions": { + "type": "object", + "description": "The component version property.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VersionsCapability": { + "description": "The version capability.", + "properties": { + "available": { + "description": "The list of version capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/VersionSpec" + } + } + } + }, + "RegionsCapability": { + "description": "The regions capability.", + "properties": { + "available": { + "description": "The list of region capabilities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VmSizesCapability": { + "description": "The virtual machine sizes capability.", + "properties": { + "available": { + "description": "The list of virtual machine size capabilities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VmSizeCompatibilityFilter": { + "description": "The virtual machine type compatibility filter.", + "properties": { + "FilterMode": { + "description": "The mode for the filter.", + "type": "string" + }, + "Regions": { + "description": "The list of regions.", + "type": "array", + "items": { + "type": "string" + } + }, + "ClusterFlavors": { + "description": "The list of cluster types available.", + "type": "array", + "items": { + "type": "string" + } + }, + "NodeTypes": { + "description": "The list of node types.", + "type": "array", + "items": { + "type": "string" + } + }, + "ClusterVersions": { + "description": "The list of cluster versions.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmsizes": { + "description": "The list of virtual machine sizes.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RegionalQuotaCapability": { + "description": "The regional quota capacity.", + "properties": { + "region_name": { + "description": "The region name.", + "type": "string" + }, + "cores_used": { + "description": "The number of cores used in the region.", + "type": "integer", + "format": "int64" + }, + "cores_available": { + "description": "The number of courses available in the region.", + "type": "integer", + "format": "int64" + } + } + }, + "QuotaCapability": { + "description": "The regional quota capability.", + "properties": { + "regionalQuotas": { + "description": "The list of region quota capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/RegionalQuotaCapability" + } + } + } + }, + "CapabilitiesResult": { + "description": "The Get Capabilities operation response.", + "properties": { + "versions": { + "description": "The version capability.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VersionsCapability" + } + }, + "regions": { + "description": "The virtual machine size compatibilty features.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RegionsCapability" + } + }, + "vmSizes": { + "description": "The virtual machine sizes.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VmSizesCapability" + } + }, + "vmSize_filters": { + "description": "The virtual machine size compatibilty filters.", + "type": "array", + "items": { + "$ref": "#/definitions/VmSizeCompatibilityFilter" + } + }, + "features": { + "description": "The capabilty features.", + "type": "array", + "items": { + "type": "string" + } + }, + "quota": { + "description": "The quota capability.", + "$ref": "#/definitions/QuotaCapability" + } + } + }, + "LocalizedName": { + "description": "The details about the localizable name of a type of usage.", + "properties": { + "value": { + "description": "The name of the used resource.", + "type": "string" + }, + "localizedValue": { + "description": "The localized name of the used resource.", + "type": "string" + } + } + }, + "Usage": { + "description": "The details about the usage of a particular limited resource.", + "properties": { + "unit": { + "description": "The type of measurement for usage.", + "type": "string" + }, + "currentValue": { + "description": "The current usage.", + "type": "integer" + }, + "limit": { + "description": "The maximum allowed usage.", + "type": "integer" + }, + "name": { + "description": "The details about the localizable name of the used resource.", + "$ref": "#/definitions/LocalizedName" + } + } + }, + "UsagesListResult": { + "description": "The response for the operation to get regional usages for a subscription.", + "properties": { + "value": { + "description": "The list of usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json index b50054bcb1ed..0efaa20c3864 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json @@ -1,460 +1,460 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2015-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}": { - "delete": { - "tags": [ - "ScriptActions" - ], - "operationId": "ScriptActions_Delete", - "description": "Deletes a specified persisted script action of the cluster.", - "x-ms-examples": { - "Delete a script action on HDInsight cluster": { - "$ref": "./examples/DeleteScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_ExecuteScriptActions", - "description": "Executes script actions on the specified HDInsight cluster.", - "x-ms-examples": { - "Execute script action on HDInsight cluster": { - "$ref": "./examples/PostExecuteScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" - }, - "description": "The parameters for executing script actions." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "OK response definition." - }, - "200": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { - "get": { - "tags": [ - "ScriptActions" - ], - "operationId": "ScriptActions_ListPersistedScripts", - "description": "Lists all the persisted script actions for the specified cluster.", - "x-ms-examples": { - "List all persisted script actions for the given cluster": { - "$ref": "./examples/GetLinuxHadoopScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ScriptActionsList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { - "get": { - "tags": [ - "ScriptExecutionHistory" - ], - "operationId": "ScriptActions_GetExecutionDetail", - "description": "Gets the script execution detail for the given script execution ID.", - "x-ms-examples": { - "Get script execution history by script id": { - "$ref": "./examples/GetScriptActionById.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptExecutionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { - "get": { - "tags": [ - "ScriptExecutionHistory" - ], - "operationId": "ScriptExecutionHistory_List", - "description": "Lists all scripts' execution history for the specified cluster.", - "x-ms-examples": { - "Get Script Execution History List": { - "$ref": "./examples/GetScriptExecutionHistory.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ScriptActionExecutionHistoryList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { - "post": { - "tags": [ - "Promote" - ], - "operationId": "ScriptExecutionHistory_Promote", - "description": "Promotes the specified ad-hoc script execution to a persisted script.", - "x-ms-examples": { - "Promote a script action on HDInsight cluster": { - "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptExecutionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - } - } - } - } - }, - "definitions": { - "ScriptActionExecutionHistoryList": { - "description": "The list script execution history response.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - }, - "description": "The list of persisted script action details for the cluster." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - }, - "ClusterListRuntimeScriptActionDetailResult": { - "description": "The list runtime script action detail response.", - "properties": { - "value": { - "description": "The list of persisted script action details for the cluster.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - }, - "ScriptAction": { - "properties": { - "name": { - "type": "string", - "description": "The name of the script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script provided." - } - }, - "required": [ - "name", - "uri", - "parameters" - ], - "description": "Describes a script action on role on the cluster." - }, - "ScriptActionPersistedGetResponseSpec": { - "description": "The persisted script action for cluster.", - "properties": { - "name": { - "type": "string", - "description": "The name of script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script provided." - }, - "roles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of roles where script will be executed." - }, - "applicationName": { - "type": "string", - "description": "The application name for the script action." - } - } - }, - "ScriptActionsList": { - "description": "The persisted script action for the cluster.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - }, - "description": "The list of persisted script action details for the cluster." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ScriptNameParameter": { - "name": "scriptName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the script.", - "x-ms-parameter-location": "method" - }, - "ScriptExecutionIdParameter": { - "name": "scriptExecutionId", - "in": "path", - "required": true, - "type": "string", - "description": "The script execution Id", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2015-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}": { + "delete": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_Delete", + "description": "Deletes a specified persisted script action of the cluster.", + "x-ms-examples": { + "Delete a script action on HDInsight cluster": { + "$ref": "./examples/DeleteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ExecuteScriptActions", + "description": "Executes script actions on the specified HDInsight cluster.", + "x-ms-examples": { + "Execute script action on HDInsight cluster": { + "$ref": "./examples/PostExecuteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" + }, + "description": "The parameters for executing script actions." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "OK response definition." + }, + "200": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { + "get": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_ListPersistedScripts", + "description": "Lists all the persisted script actions for the specified cluster.", + "x-ms-examples": { + "List all persisted script actions for the given cluster": { + "$ref": "./examples/GetLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptActions_GetExecutionDetail", + "description": "Gets the script execution detail for the given script execution ID.", + "x-ms-examples": { + "Get script execution history by script id": { + "$ref": "./examples/GetScriptActionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptExecutionHistory_List", + "description": "Lists all scripts' execution history for the specified cluster.", + "x-ms-examples": { + "Get Script Execution History List": { + "$ref": "./examples/GetScriptExecutionHistory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionExecutionHistoryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { + "post": { + "tags": [ + "Promote" + ], + "operationId": "ScriptExecutionHistory_Promote", + "description": "Promotes the specified ad-hoc script execution to a persisted script.", + "x-ms-examples": { + "Promote a script action on HDInsight cluster": { + "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + } + }, + "definitions": { + "ScriptActionExecutionHistoryList": { + "description": "The list script execution history response.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ClusterListRuntimeScriptActionDetailResult": { + "description": "The list runtime script action detail response.", + "properties": { + "value": { + "description": "The list of persisted script action details for the cluster.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + } + }, + "required": [ + "name", + "uri", + "parameters" + ], + "description": "Describes a script action on role on the cluster." + }, + "ScriptActionPersistedGetResponseSpec": { + "description": "The persisted script action for cluster.", + "properties": { + "name": { + "type": "string", + "description": "The name of script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "type": "string", + "description": "The application name for the script action." + } + } + }, + "ScriptActionsList": { + "description": "The persisted script action for the cluster.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the script.", + "x-ms-parameter-location": "method" + }, + "ScriptExecutionIdParameter": { + "name": "scriptExecutionId", + "in": "path", + "required": true, + "type": "string", + "description": "The script execution Id", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json index 2a77e99c11dd..2da3dcf63013 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json @@ -1,1162 +1,1162 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2018-06-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}": { - "put": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Create", - "description": "Creates a new HDInsight cluster with the specified parameters.", - "x-ms-examples": { - "Create Hadoop on Linux cluster with SSH password": { - "$ref": "./examples/CreateLinuxHadoopSshPassword.json" - }, - "Create Hadoop on Linux cluster with SSH public key": { - "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" - }, - "Create Spark on Linux Cluster with SSH password": { - "$ref": "./examples/CreateLinuxSparkSshPassword.json" - }, - "Create Secure Hadoop cluster": { - "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" - }, - "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { - "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterCreateParametersExtended" - }, - "description": "The cluster create request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Update", - "description": "Patch HDInsight cluster with the specified parameters.", - "x-ms-examples": { - "Patch HDInsight Linux clusters": { - "$ref": "./examples/PatchLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPatchParameters" - }, - "description": "The cluster patch request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - } - }, - "delete": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Delete", - "description": "Deletes the specified HDInsight cluster.", - "x-ms-examples": { - "Delete Hadoop on Linux cluster": { - "$ref": "./examples/DeleteLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "Accepted response definition." - }, - "200": { - "description": "Ok response definition." - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Get", - "description": "Gets the specified cluster.", - "x-ms-examples": { - "Get Hadoop on Linux cluster": { - "$ref": "./examples/GetLinuxHadoopCluster.json" - }, - "Get Spark on Linux cluster": { - "$ref": "./examples/GetLinuxSparkCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "description": "Lists the HDInsight clusters in a resource group.", - "x-ms-examples": { - "Get All Hadoop on Linux clusters in a resource group": { - "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_Resize", - "description": "Resizes the specified HDInsight cluster to the specified size.", - "x-ms-examples": { - "Resize the worker nodes for a Hadoop on Linux cluster": { - "$ref": "./examples/ResizeLinuxHadoopCluster.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "roleName", - "in": "path", - "required": true, - "type": "string", - "description": "The constant value for the roleName", - "enum": [ - "workernode" - ], - "x-ms-enum": { - "name": "RoleName", - "modelAsString": true - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterResizeParameters" - }, - "description": "The parameters for the resize operation." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { - "get": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_List", - "x-ms-examples": { - "Get All Hadoop on Linux clusters": { - "$ref": "./examples/GetLinuxHadoopAllClusters.json" - } - }, - "description": "Lists all the HDInsight clusters under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ClusterDefinition": { - "description": "The cluster definition.", - "properties": { - "blueprint": { - "type": "string", - "description": "The link to the blueprint." - }, - "kind": { - "type": "string", - "description": "The type of cluster." - }, - "componentVersion": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The versions of different services in the cluster." - }, - "configurations": { - "type": "object", - "description": "The cluster configurations." - } - } - }, - "SecurityProfile": { - "description": "The security profile which contains Ssh public key for the HDInsight cluster.", - "properties": { - "directoryType": { - "type": "string", - "description": "The directory type.", - "enum": [ - "ActiveDirectory" - ], - "x-ms-enum": { - "name": "DirectoryType", - "modelAsString": false - } - }, - "domain": { - "type": "string", - "description": "The organization's active directory domain." - }, - "organizationalUnitDN": { - "type": "string", - "description": "The organizational unit within the Active Directory to place the cluster and service accounts." - }, - "ldapsUrls": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The LDAPS protocol URLs to communicate with the Active Directory." - }, - "domainUsername": { - "type": "string", - "description": "The domain user account that will have admin privileges on the cluster." - }, - "domainUserPassword": { - "type": "string", - "format": "password", - "description": "The domain admin password." - }, - "clusterUsersGroupDNs": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional. The Distinguished Names for cluster user groups" - } - } - }, - "HardwareProfile": { - "properties": { - "vmSize": { - "type": "string", - "description": "The size of the VM" - } - }, - "description": "The hardware profile." - }, - "VirtualNetworkProfile": { - "description": "The virtual network properties.", - "properties": { - "id": { - "type": "string", - "description": "The ID of the virtual network." - }, - "subnet": { - "type": "string", - "description": "The name of the subnet." - } - } - }, - "DataDisksGroups": { - "description": "The data disks groups for the role.", - "properties": { - "disksPerNode": { - "type": "integer", - "format": "int32", - "description": "The number of disks per node." - }, - "storageAccountType": { - "type": "string", - "description": "ReadOnly. The storage account type. Do not set this value.", - "readOnly": true - }, - "diskSizeGB": { - "type": "integer", - "description": "ReadOnly. The DiskSize in GB. Do not set this value.", - "readOnly": true - } - } - }, - "SshPublicKey": { - "description": "The SSH public key for the cluster nodes.", - "properties": { - "certificateData": { - "type": "string", - "description": "The certificate for SSH." - } - } - }, - "SshProfile": { - "description": "The list of SSH public keys.", - "properties": { - "publicKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - }, - "description": "The list of SSH public keys." - } - } - }, - "LinuxOperatingSystemProfile": { - "description": "The ssh username, password, and ssh public key.", - "properties": { - "username": { - "type": "string", - "description": "The username." - }, - "password": { - "type": "string", - "description": "The password." - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile", - "description": "The SSH profile." - } - } - }, - "OsProfile": { - "description": "The Linux operation systems profile.", - "properties": { - "linuxOperatingSystemProfile": { - "$ref": "#/definitions/LinuxOperatingSystemProfile", - "description": "The Linux OS profile." - } - } - }, - "Role": { - "properties": { - "name": { - "type": "string", - "description": "The name of the role." - }, - "minInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The minimum instance count of the cluster." - }, - "targetInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The instance count of the cluster." - }, - "hardwareProfile": { - "$ref": "#/definitions/HardwareProfile", - "description": "The hardware profile." - }, - "osProfile": { - "$ref": "#/definitions/OsProfile", - "description": "The operating system profile." - }, - "virtualNetworkProfile": { - "$ref": "#/definitions/VirtualNetworkProfile", - "description": "The virtual network profile." - }, - "dataDisksGroups": { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisksGroups" - }, - "description": "The data disks groups for the role." - }, - "scriptActions": { - "type": "array", - "items": { - "$ref": "./scriptActions.json#/definitions/ScriptAction" - }, - "description": "The list of script actions on the role." - } - }, - "description": "Describes a role on the cluster." - }, - "ComputeProfile": { - "properties": { - "roles": { - "type": "array", - "items": { - "$ref": "#/definitions/Role" - }, - "description": "The list of roles in the cluster." - } - }, - "description": "Describes the compute profile." - }, - "StorageAccount": { - "properties": { - "name": { - "type": "string", - "description": "The name of the storage account." - }, - "isDefault": { - "type": "boolean", - "description": "Whether or not the storage account is the default storage account." - }, - "container": { - "type": "string", - "description": "The container in the storage account, only to be specified for WASB storage accounts." - }, - "fileSystem": { - "type": "string", - "description": "The filesystem, only to be specified for Azure Data Lake Storage type Gen 2." - }, - "key": { - "type": "string", - "description": "The storage account access key." - } - }, - "description": "The storage Account." - }, - "StorageProfile": { - "properties": { - "storageaccounts": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "The list of storage accounts in the cluster." - } - }, - "description": "The storage profile." - }, - "ClusterCreateProperties": { - "description": "The cluster create parameters.", - "properties": { - "clusterVersion": { - "type": "string", - "description": "The version of the cluster." - }, - "osType": { - "type": "string", - "description": "The type of operating system.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OSType", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The cluster tier.", - "enum": [ - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "Tier", - "modelAsString": false - } - }, - "clusterDefinition": { - "$ref": "#/definitions/ClusterDefinition", - "description": "The cluster definition." - }, - "securityProfile": { - "$ref": "#/definitions/SecurityProfile", - "description": "The security profile." - }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfile", - "description": "The compute profile." - }, - "storageProfile": { - "$ref": "#/definitions/StorageProfile", - "description": "The storage profile." - } - } - }, - "ClusterCreateParametersExtended": { - "properties": { - "location": { - "type": "string", - "description": "The location of the cluster." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - }, - "properties": { - "$ref": "#/definitions/ClusterCreateProperties", - "description": "The cluster create parameters." - } - }, - "description": "The CreateCluster request parameters." - }, - "ClusterPatchParameters": { - "properties": { - "tags": { - "type": "object", - "x-nullable": true, - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - } - }, - "description": "The PatchCluster request parameters" - }, - "QuotaInfo": { - "description": "The quota properties for the cluster.", - "properties": { - "coresUsed": { - "type": "integer", - "format": "int32", - "description": "The cores used by the cluster." - } - } - }, - "Errors": { - "description": "The error message associated with the cluster creation.", - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - } - }, - "ConnectivityEndpoint": { - "description": "The connectivity properties", - "properties": { - "name": { - "type": "string", - "description": "The name of the endpoint." - }, - "protocol": { - "type": "string", - "description": "The protocol of the endpoint." - }, - "location": { - "type": "string", - "description": "The location of the endpoint." - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The port to connect to." - } - } - }, - "ClusterGetProperties": { - "description": "The properties of cluster.", - "properties": { - "clusterVersion": { - "type": "string", - "description": "The version of the cluster." - }, - "osType": { - "type": "string", - "description": "The type of operating system.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OSType", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The cluster tier.", - "enum": [ - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "Tier", - "modelAsString": false - } - }, - "clusterDefinition": { - "$ref": "#/definitions/ClusterDefinition", - "description": "The cluster definition." - }, - "securityProfile": { - "$ref": "#/definitions/SecurityProfile", - "description": "The security profile." - }, - "computeProfile": { - "$ref": "#/definitions/ComputeProfile", - "description": "The compute profile." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state, which only appears in the response.", - "enum": [ - "InProgress", - "Failed", - "Succeeded", - "Canceled", - "Deleting" - ], - "x-ms-enum": { - "name": "HDInsightClusterProvisioningState", - "modelAsString": false - } - }, - "createdDate": { - "type": "string", - "description": "The date on which the cluster was created." - }, - "clusterState": { - "type": "string", - "description": "The state of the cluster." - }, - "quotaInfo": { - "$ref": "#/definitions/QuotaInfo", - "description": "The quota information." - }, - "errors": { - "type": "array", - "items": { - "$ref": "#/definitions/Errors" - }, - "description": "The list of errors." - }, - "connectivityEndpoints": { - "type": "array", - "items": { - "$ref": "#/definitions/ConnectivityEndpoint" - }, - "description": "The list of connectivity endpoints." - } - }, - "required": [ - "clusterDefinition" - ] - }, - "Cluster": { - "allOf": [{ - "$ref": "#/definitions/TrackedResource" - }], - "properties": { - "etag": { - "type": "string", - "description": "The ETag for the resource" - }, - "properties": { - "$ref": "#/definitions/ClusterGetProperties", - "description": "The properties of the cluster." - } - }, - "description": "The HDInsight cluster." - }, - "RuntimeScriptAction": { - "properties": { - "name": { - "type": "string", - "description": "The name of the script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script" - }, - "roles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of roles where script will be executed." - }, - "applicationName": { - "readOnly": true, - "type": "string", - "description": "The application name of the script action, if any." - } - }, - "required": [ - "name", - "uri", - "roles" - ], - "description": "Describes a script action on a running cluster." - }, - "ExecuteScriptActionParameters": { - "properties": { - "scriptActions": { - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptAction" - }, - "description": "The list of run time script actions." - }, - "persistOnSuccess": { - "type": "boolean", - "description": "Gets or sets if the scripts needs to be persisted." - } - }, - "required": [ - "persistOnSuccess" - ], - "description": "The parameters for the script actions to execute on a running cluster." - }, - "ClusterListPersistedScriptActionsResult": { - "properties": { - "value": { - "description": "The list of Persisted Script Actions.", - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptAction" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The ListPersistedScriptActions operation response." - }, - "ScriptActionExecutionSummary": { - "properties": { - "status": { - "readOnly": true, - "type": "string", - "description": "The status of script action execution." - }, - "instanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The instance count for a given script action execution status." - } - }, - "description": "The execution summary of a script action." - }, - "RuntimeScriptActionDetail": { - "allOf": [ - { - "$ref": "#/definitions/RuntimeScriptAction" - }, - { - "properties": { - "scriptExecutionId": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The execution id of the script action." - }, - "startTime": { - "readOnly": true, - "type": "string", - "description": "The start time of script action execution." - }, - "endTime": { - "readOnly": true, - "type": "string", - "description": "The end time of script action execution." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "The current execution status of the script action." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "The reason why the script action was executed." - }, - "executionSummary": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ScriptActionExecutionSummary" - }, - "description": "The summary of script action execution result." - }, - "debugInformation": { - "readOnly": true, - "type": "string", - "description": "The script action execution debug information." - } - } - } - ], - "description": "The execution details of a script action." - }, - "ClusterListRuntimeScriptActionDetailResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/RuntimeScriptActionDetail" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The list runtime script action detail response." - }, - "ClusterListResult": { - "properties": { - "value": { - "description": "The list of Clusters.", - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - }, - "description": "The List Cluster operation response." - }, - "ClusterResizeParameters": { - "properties": { - "targetInstanceCount": { - "type": "integer", - "format": "int32", - "description": "The target instance count for the operation." - } - }, - "description": "The Resize Cluster request parameters." - }, - "OperationResource": { - "properties": { - "status": { - "type": "string", - "description": "The async operation state.", - "enum": [ - "InProgress", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "AsyncOperationState", - "modelAsString": false - } - }, - "error": { - "$ref": "#/definitions/Errors", - "description": "The operation error information." - } - }, - "description": "The azure async operation response." - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "description": "Creates a new HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Create Hadoop on Linux cluster with SSH password": { + "$ref": "./examples/CreateLinuxHadoopSshPassword.json" + }, + "Create Hadoop on Linux cluster with SSH public key": { + "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" + }, + "Create Spark on Linux Cluster with SSH password": { + "$ref": "./examples/CreateLinuxSparkSshPassword.json" + }, + "Create Secure Hadoop cluster": { + "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" + }, + "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { + "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateParametersExtended" + }, + "description": "The cluster create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "description": "Patch HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Patch HDInsight Linux clusters": { + "$ref": "./examples/PatchLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + }, + "description": "The cluster patch request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "description": "Deletes the specified HDInsight cluster.", + "x-ms-examples": { + "Delete Hadoop on Linux cluster": { + "$ref": "./examples/DeleteLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "Ok response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "description": "Gets the specified cluster.", + "x-ms-examples": { + "Get Hadoop on Linux cluster": { + "$ref": "./examples/GetLinuxHadoopCluster.json" + }, + "Get Spark on Linux cluster": { + "$ref": "./examples/GetLinuxSparkCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "description": "Lists the HDInsight clusters in a resource group.", + "x-ms-examples": { + "Get All Hadoop on Linux clusters in a resource group": { + "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Resize", + "description": "Resizes the specified HDInsight cluster to the specified size.", + "x-ms-examples": { + "Resize the worker nodes for a Hadoop on Linux cluster": { + "$ref": "./examples/ResizeLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the roleName", + "enum": [ + "workernode" + ], + "x-ms-enum": { + "name": "RoleName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResizeParameters" + }, + "description": "The parameters for the resize operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "Get All Hadoop on Linux clusters": { + "$ref": "./examples/GetLinuxHadoopAllClusters.json" + } + }, + "description": "Lists all the HDInsight clusters under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ClusterDefinition": { + "description": "The cluster definition.", + "properties": { + "blueprint": { + "type": "string", + "description": "The link to the blueprint." + }, + "kind": { + "type": "string", + "description": "The type of cluster." + }, + "componentVersion": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The versions of different services in the cluster." + }, + "configurations": { + "type": "object", + "description": "The cluster configurations." + } + } + }, + "SecurityProfile": { + "description": "The security profile which contains Ssh public key for the HDInsight cluster.", + "properties": { + "directoryType": { + "type": "string", + "description": "The directory type.", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "DirectoryType", + "modelAsString": false + } + }, + "domain": { + "type": "string", + "description": "The organization's active directory domain." + }, + "organizationalUnitDN": { + "type": "string", + "description": "The organizational unit within the Active Directory to place the cluster and service accounts." + }, + "ldapsUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The LDAPS protocol URLs to communicate with the Active Directory." + }, + "domainUsername": { + "type": "string", + "description": "The domain user account that will have admin privileges on the cluster." + }, + "domainUserPassword": { + "type": "string", + "format": "password", + "description": "The domain admin password." + }, + "clusterUsersGroupDNs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The Distinguished Names for cluster user groups" + } + } + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "The size of the VM" + } + }, + "description": "The hardware profile." + }, + "VirtualNetworkProfile": { + "description": "The virtual network properties.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the virtual network." + }, + "subnet": { + "type": "string", + "description": "The name of the subnet." + } + } + }, + "DataDisksGroups": { + "description": "The data disks groups for the role.", + "properties": { + "disksPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of disks per node." + }, + "storageAccountType": { + "type": "string", + "description": "ReadOnly. The storage account type. Do not set this value.", + "readOnly": true + }, + "diskSizeGB": { + "type": "integer", + "description": "ReadOnly. The DiskSize in GB. Do not set this value.", + "readOnly": true + } + } + }, + "SshPublicKey": { + "description": "The SSH public key for the cluster nodes.", + "properties": { + "certificateData": { + "type": "string", + "description": "The certificate for SSH." + } + } + }, + "SshProfile": { + "description": "The list of SSH public keys.", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys." + } + } + }, + "LinuxOperatingSystemProfile": { + "description": "The ssh username, password, and ssh public key.", + "properties": { + "username": { + "type": "string", + "description": "The username." + }, + "password": { + "type": "string", + "description": "The password." + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile", + "description": "The SSH profile." + } + } + }, + "OsProfile": { + "description": "The Linux operation systems profile.", + "properties": { + "linuxOperatingSystemProfile": { + "$ref": "#/definitions/LinuxOperatingSystemProfile", + "description": "The Linux OS profile." + } + } + }, + "Role": { + "properties": { + "name": { + "type": "string", + "description": "The name of the role." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster." + }, + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The instance count of the cluster." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "The hardware profile." + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The operating system profile." + }, + "virtualNetworkProfile": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "The virtual network profile." + }, + "dataDisksGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisksGroups" + }, + "description": "The data disks groups for the role." + }, + "scriptActions": { + "type": "array", + "items": { + "$ref": "./scriptActions.json#/definitions/ScriptAction" + }, + "description": "The list of script actions on the role." + } + }, + "description": "Describes a role on the cluster." + }, + "ComputeProfile": { + "properties": { + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The list of roles in the cluster." + } + }, + "description": "Describes the compute profile." + }, + "StorageAccount": { + "properties": { + "name": { + "type": "string", + "description": "The name of the storage account." + }, + "isDefault": { + "type": "boolean", + "description": "Whether or not the storage account is the default storage account." + }, + "container": { + "type": "string", + "description": "The container in the storage account, only to be specified for WASB storage accounts." + }, + "fileSystem": { + "type": "string", + "description": "The filesystem, only to be specified for Azure Data Lake Storage type Gen 2." + }, + "key": { + "type": "string", + "description": "The storage account access key." + } + }, + "description": "The storage Account." + }, + "StorageProfile": { + "properties": { + "storageaccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The list of storage accounts in the cluster." + } + }, + "description": "The storage profile." + }, + "ClusterCreateProperties": { + "description": "The cluster create parameters.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile." + } + } + }, + "ClusterCreateParametersExtended": { + "properties": { + "location": { + "type": "string", + "description": "The location of the cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "properties": { + "$ref": "#/definitions/ClusterCreateProperties", + "description": "The cluster create parameters." + } + }, + "description": "The CreateCluster request parameters." + }, + "ClusterPatchParameters": { + "properties": { + "tags": { + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "description": "The PatchCluster request parameters" + }, + "QuotaInfo": { + "description": "The quota properties for the cluster.", + "properties": { + "coresUsed": { + "type": "integer", + "format": "int32", + "description": "The cores used by the cluster." + } + } + }, + "Errors": { + "description": "The error message associated with the cluster creation.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ConnectivityEndpoint": { + "description": "The connectivity properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "protocol": { + "type": "string", + "description": "The protocol of the endpoint." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port to connect to." + } + } + }, + "ClusterGetProperties": { + "description": "The properties of cluster.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": false + } + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "HDInsightClusterProvisioningState", + "modelAsString": false + } + }, + "createdDate": { + "type": "string", + "description": "The date on which the cluster was created." + }, + "clusterState": { + "type": "string", + "description": "The state of the cluster." + }, + "quotaInfo": { + "$ref": "#/definitions/QuotaInfo", + "description": "The quota information." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Errors" + }, + "description": "The list of errors." + }, + "connectivityEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityEndpoint" + }, + "description": "The list of connectivity endpoints." + } + }, + "required": [ + "clusterDefinition" + ] + }, + "Cluster": { + "allOf": [{ + "$ref": "#/definitions/TrackedResource" + }], + "properties": { + "etag": { + "type": "string", + "description": "The ETag for the resource" + }, + "properties": { + "$ref": "#/definitions/ClusterGetProperties", + "description": "The properties of the cluster." + } + }, + "description": "The HDInsight cluster." + }, + "RuntimeScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "readOnly": true, + "type": "string", + "description": "The application name of the script action, if any." + } + }, + "required": [ + "name", + "uri", + "roles" + ], + "description": "Describes a script action on a running cluster." + }, + "ExecuteScriptActionParameters": { + "properties": { + "scriptActions": { + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + }, + "description": "The list of run time script actions." + }, + "persistOnSuccess": { + "type": "boolean", + "description": "Gets or sets if the scripts needs to be persisted." + } + }, + "required": [ + "persistOnSuccess" + ], + "description": "The parameters for the script actions to execute on a running cluster." + }, + "ClusterListPersistedScriptActionsResult": { + "properties": { + "value": { + "description": "The list of Persisted Script Actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The ListPersistedScriptActions operation response." + }, + "ScriptActionExecutionSummary": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of script action execution." + }, + "instanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The instance count for a given script action execution status." + } + }, + "description": "The execution summary of a script action." + }, + "RuntimeScriptActionDetail": { + "allOf": [ + { + "$ref": "#/definitions/RuntimeScriptAction" + }, + { + "properties": { + "scriptExecutionId": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The execution id of the script action." + }, + "startTime": { + "readOnly": true, + "type": "string", + "description": "The start time of script action execution." + }, + "endTime": { + "readOnly": true, + "type": "string", + "description": "The end time of script action execution." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The current execution status of the script action." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The reason why the script action was executed." + }, + "executionSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ScriptActionExecutionSummary" + }, + "description": "The summary of script action execution result." + }, + "debugInformation": { + "readOnly": true, + "type": "string", + "description": "The script action execution debug information." + } + } + } + ], + "description": "The execution details of a script action." + }, + "ClusterListRuntimeScriptActionDetailResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The list runtime script action detail response." + }, + "ClusterListResult": { + "properties": { + "value": { + "description": "The list of Clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The List Cluster operation response." + }, + "ClusterResizeParameters": { + "properties": { + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The target instance count for the operation." + } + }, + "description": "The Resize Cluster request parameters." + }, + "OperationResource": { + "properties": { + "status": { + "type": "string", + "description": "The async operation state.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationState", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/Errors", + "description": "The operation error information." + } + }, + "description": "The azure async operation response." + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json index 195561448e30..7206e756b642 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/configurations.json @@ -1,189 +1,189 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2018-06-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { - "post": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Update", - "description": "Configures the configuration on the specified cluster.", - "x-ms-examples": { - "Enable HTTP connectivity": { - "$ref": "./examples/ChangeHttpConnectivityEnable.json" - }, - "Disable HTTP connectivity": { - "$ref": "./examples/ChangeHttpConnectivityDisable.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - }, - "description": "The cluster configurations." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition" - }, - "202": { - "description": "Accepted response definition" - }, - "204": { - "description": "No content response definition" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Get", - "description": "The configuration object for the specified cluster.", - "x-ms-examples": { - "Get HTTP settings": { - "$ref": "./examples/GetHttpConnectivity.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - } - } - } - } - } - }, - "definitions": { - "ClusterConfiguration": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The configuration object for the specified configuration for the specified cluster." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ConfigurationNameParameter": { - "name": "configurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster configuration.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "description": "Configures the configuration on the specified cluster.", + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityEnable.json" + }, + "Disable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityDisable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition" + }, + "202": { + "description": "Accepted response definition" + }, + "204": { + "description": "No content response definition" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "description": "The configuration object for the specified cluster.", + "x-ms-examples": { + "Get HTTP settings": { + "$ref": "./examples/GetHttpConnectivity.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + } + } + } + }, + "definitions": { + "ClusterConfiguration": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The configuration object for the specified configuration for the specified cluster." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster configuration.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json index 36e6abcfc05e..ee0cefc7b821 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityDisable.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway", - "parameters": { - "restAuthCredential.isEnabled": "false" - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {}, - "204": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "false" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json index 11b287ddbef3..2975ff6d576f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ChangeHttpConnectivityEnable.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway", - "parameters": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {}, - "204": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json index 0ba75a738687..2ef0440b833e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateExtension.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring", - "parameters": { - "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", - "primaryKey": "**********" - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json index 0c791b3d6937..1d9094f8d80c 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopAdlsGen2.json @@ -1,88 +1,88 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "parameters": { - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.6", - "osType": "Linux", - "tier": "Standard", - "clusterDefinition": { - "kind": "Hadoop", - "configurations": { - "gateway": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "admin", - "restAuthCredential.password": "**********" - } - } - }, - "storageProfile": { - "storageaccounts": [ - { - "name": "mystorage.dfs.core.windows.net", - "isDefault": true, - "fileSystem": "default", - "key": "storagekey" - } - ] - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "minInstanceCount": 1, - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - }, - { - "name": "workernode", - "minInstanceCount": 1, - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - }, - { - "name": "zookeepernode", - "minInstanceCount": 1, - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Small" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser", - "password": "**********" - } - } - } - ] - } - } - } - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.dfs.core.windows.net", + "isDefault": true, + "fileSystem": "default", + "key": "storagekey" + } + ] + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json index 23d14c01f45d..e10fc4227e99 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteApplication.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "applicationName": "hue", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "202": {} - } +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json index d73289f0c7a1..5ab33a68737f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteExtension.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring" - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json index b1c8b19d9927..fa8321bcaeb3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteLinuxHadoopCluster.json @@ -1,12 +1,12 @@ - { - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "202": {}, - "200": {} - } + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json index 3a430578e53f..66dcf8633aa1 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DeleteScriptAction.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "scriptName": "scriptName" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptName": "scriptName" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json index d850812235da..3b5289d0db70 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/DisableLinuxClusterMonitoring.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json index 2206311af486..f7bc5b41ef13 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/EnableLinuxClusterMonitoring.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "parameters": { - "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", - "primaryKey": "**********" - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json index 7f9fb39ed54d..24237fb08d4e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetAllApplications.json @@ -1,89 +1,89 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D12_v2" - } - }] - }, - "installScriptActions": [{ - "name": "app-install-app", - "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "https://cluster1-app.apps.azurehdinsight.net:443", - "destinationPort": 20000, - "publicPort": 443 - }], - "sshEndpoints": [{ - "location": "app.cluster1-ssh.azurehdinsight.net:22", - "destinationPort": 22, - "publicPort": 22 - }], - "provisioningState": "Succeeded", - "applicationState": "Running", - "createdDate": "2017-03-22T21:34:39.293", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" - } - }, { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", - "name": "app2", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D3" - } - }] - }, - "installScriptActions": [{ - "name": "app2-Install", - "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "location", - "destinationPort": 18630, - "publicPort": 443 - }], - "sshEndpoints": [], - "provisioningState": "InProgress", - "applicationState": "AzureVMConfiguration", - "createdDate": "2017-03-28T02:01:25.107", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" - } - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install-app", + "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1-app.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "app.cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" + } + }, { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", + "name": "app2", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app2-Install", + "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json index c8f8767c7d14..c517a9e334df 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationCreated.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "applicationName": "app", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D12_v2" - } - }] - }, - "installScriptActions": [{ - "name": "app-install", - "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "https://cluster1.apps.azurehdinsight.net:443", - "destinationPort": 20000, - "publicPort": 443 - }], - "sshEndpoints": [{ - "location": "cluster1-ssh.azurehdinsight.net:22", - "destinationPort": 22, - "publicPort": 22 - }], - "provisioningState": "Succeeded", - "applicationState": "Running", - "createdDate": "2017-03-22T21:34:39.293", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "appMarketId" - } - } - } - } +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + }] + }, + "installScriptActions": [{ + "name": "app-install", + "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "https://cluster1.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + }], + "sshEndpoints": [{ + "location": "cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + }], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "appMarketId" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json index c54dd5425f8d..de0f68047fc5 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetApplicationInProgress.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "applicationName": "app", - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", - "name": "app", - "type": "Microsoft.HDInsight/clusters/applications", - "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", - "tags": { "key1": "val1" }, - "properties": { - "computeProfile": { - "roles": [{ - "name": "edgenode", - "targetInstanceCount": 1, - "hardwareProfile": { - "vmSize": "Standard_D3" - } - }] - }, - "installScriptActions": [{ - "name": "app-Install", - "uri": "https://app.com/azure/app_install.sh", - "roles": ["edgenode"] - }], - "uninstallScriptActions": [], - "httpsEndpoints": [{ - "accessModes": ["WebPage"], - "location": "location", - "destinationPort": 18630, - "publicPort": 443 - }], - "sshEndpoints": [], - "provisioningState": "InProgress", - "applicationState": "AzureVMConfiguration", - "createdDate": "2017-03-28T02:01:25.107", - "applicationType": "CustomApplication", - "marketplaceIdentifier": "id" - } - } - } - } +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { "key1": "val1" }, + "properties": { + "computeProfile": { + "roles": [{ + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + }] + }, + "installScriptActions": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "roles": ["edgenode"] + }], + "uninstallScriptActions": [], + "httpsEndpoints": [{ + "accessModes": ["WebPage"], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + }], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "id" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json index d7cce776a632..511c866cd913 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetExtension.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "extensionName": "clustermonitoring" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json index c0d5a5b4653c..8b261609ffb3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHDInsightUsages.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "location": "West US", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "Body": { - "value": [ - { - "unit": "Count", - "currentValue": 0, - "limit": 5000, - "name": { - "value": "cores", - "localizedValue": "Cores" - } - } - ] - } - } - } +{ + "parameters": { + "location": "West US", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "Body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 5000, + "name": { + "value": "cores", + "localizedValue": "Cores" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json index 75ff30e36059..d569dfbdd73e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetHttpConnectivity.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "configurationName": "gateway" - }, - "responses": { - "200": { - "body": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "configurationName": "gateway" + }, + "responses": { + "200": { + "body": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json index 99ce8d118673..56e95ca51075 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxClusterMonitoringStatus.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json index 538cd8531681..2a41a0163347 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClusters.json @@ -1,163 +1,163 @@ - { - "parameters": { - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", - "name": "cluster2", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster2-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster2.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - ] - } - } - } + { + "parameters": { + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json index 72d54d1abcdb..65d188f6c675 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json @@ -1,164 +1,164 @@ - { - "parameters": { - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", - "name": "cluster2", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "pulkitssh" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster2-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster2.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - ] - } - } - } + { + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json index 385d80ffd223..8b4586304d43 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopCluster.json @@ -1,87 +1,87 @@ - { - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", - "kind": "hadoop" - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D3_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-01-11T18:58:26.187", - "quotaInfo": { - "coresUsed": 24 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - } - } + { + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json index 35e14bd1dcde..b8dd2843d362 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptAction.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "name": "app-Install", - "uri": "https://app.com/azure/app_install.sh", - "parameters": "", - "roles": ["edgenode"], - "applicationName": "app" - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "parameters": "", + "roles": ["edgenode"], + "applicationName": "app" + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json index 60b3ddcf0b00..0c0f49003ac8 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxHadoopScriptExecutionHistory.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [{ - "scriptExecutionId": 386120808773799, - "name": "app-install", - "applicationName": "app", - "uri": "http://app.com/public/hdi-app/20170301/hdinsight-app-install.sh", - "parameters": "", - "roles": [ - "edgenode" - ], - "startTime": "2017-03-22T21:40:37.8865514Z", - "endTime": "2017-03-22T22:06:02.1584639Z", - "status": "Succeeded", - "operation": "AppInstall", - "executionSummary": [{ - "status": "COMPLETED", - "instanceCount": 1 - }] - }] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 386120808773799, + "name": "app-install", + "applicationName": "app", + "uri": "http://app.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "parameters": "", + "roles": [ + "edgenode" + ], + "startTime": "2017-03-22T21:40:37.8865514Z", + "endTime": "2017-03-22T22:06:02.1584639Z", + "status": "Succeeded", + "operation": "AppInstall", + "executionSummary": [{ + "status": "COMPLETED", + "instanceCount": 1 + }] + }] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json index d9b7e6ee6e9e..a7311de2c4b7 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetLinuxSparkCluster.json @@ -1,90 +1,90 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusters", - "location": "West US", - "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", - "tags": { "key1": "val1" }, - "properties": { - "clusterVersion": "3.5.1000.0", - "osType": "Linux", - "clusterDefinition": { - "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", - "kind": "SPARK", - "componentVersion": { - "Spark": "2.0" - } - }, - "computeProfile": { - "roles": [{ - "name": "headnode", - "targetInstanceCount": 2, - "hardwareProfile": { - "vmSize": "Standard_D12_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "workernode", - "targetInstanceCount": 4, - "hardwareProfile": { - "vmSize": "Standard_D4_V2" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - }, - { - "name": "zookeepernode", - "targetInstanceCount": 3, - "hardwareProfile": { - "vmSize": "Medium" - }, - "osProfile": { - "linuxOperatingSystemProfile": { - "username": "sshuser" - } - } - } - ] - }, - "provisioningState": "Succeeded", - "clusterState": "Running", - "createdDate": "2017-03-03T08:35:07.323", - "quotaInfo": { - "coresUsed": 40 - }, - "connectivityEndpoints": [{ - "name": "SSH", - "protocol": "TCP", - "location": "cluster1-ssh.azurehdinsight.net", - "port": 22 - }, - { - "name": "HTTPS", - "protocol": "TCP", - "location": "cluster1.azurehdinsight.net", - "port": 443 - } - ], - "tier": "Standard" - } - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", + "tags": { "key1": "val1" }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", + "kind": "SPARK", + "componentVersion": { + "Spark": "2.0" + } + }, + "computeProfile": { + "roles": [{ + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-03-03T08:35:07.323", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [{ + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json index 635a25d3e455..a184770a566d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptActionById.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": { - "body": { - "scriptExecutionId": 391145124054712, - "name": "Test", - "applicationName": "app1", - "uri": "http://testurl.com/install.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [], - "debugInformation": "" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [], + "debugInformation": "" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json index fc162160c88a..e03cddbadaca 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/GetScriptExecutionHistory.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": { - "body": { - "value": [{ - "scriptExecutionId": 391145124054712, - "name": "Test", - "applicationName": "app1", - "uri": "http://testurl.com/install.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [] - }, - { - "scriptExecutionId": 391144597342127, - "name": "Test", - "applicationName": "app2", - "uri": "http://testurl.com/install-script.ssh", - "parameters": "", - "roles": [ - "headnode", - "workernode" - ], - "startTime": "2017-03-22T21:34:39.293", - "endTime": "2017-03-22T21:34:39.293", - "status": "ValidationFailed", - "operation": "PostClusterCreateScriptActionRequest", - "executionSummary": [] - } - ] - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "value": [{ + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + }, + { + "scriptExecutionId": 391144597342127, + "name": "Test", + "applicationName": "app2", + "uri": "http://testurl.com/install-script.ssh", + "parameters": "", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json index 5727598112cc..30dbbb97bb8d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PostExecuteScriptAction.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "parameters": { - "scriptActions": [{ - "name": "Test", - "uri": "http://testurl.com/install.ssh", - "roles": [ - "headnode", - "workernode" - ], - "parameters": "" - }], - "persistOnSuccess": false - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "scriptActions": [{ + "name": "Test", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "parameters": "" + }], + "persistOnSuccess": false + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json index 2fcf642c2d56..6a285dfcf4f4 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/PromoteLinuxHadoopScriptAction.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "scriptExecutionId": "391145124054712" - }, - "responses": { - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json index cd7de3816f56..48adc2c56b9b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RdpSettingsEnable.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "parameters": { - "osProfile": { - "windowsOperatingSystemProfile": { - "rdpSettings": { - "username": "hadoop", - "password": "**********", - "expiryDate": "2017-02-28" - } - } - } - } - }, - "responses": { - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" - } - }, - "200": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "osProfile": { + "windowsOperatingSystemProfile": { + "rdpSettings": { + "username": "hadoop", + "password": "**********", + "expiryDate": "2017-02-28" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + } + }, + "200": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json index 9562da3e97c9..583be1270ced 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/ResizeLinuxHadoopCluster.json @@ -1,16 +1,16 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2018-06-01-preview", - "subscriptionId": "subid", - "roleName": "workernode", - "parameters": { - "targetInstanceCount": 10 - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "targetInstanceCount": 10 + } + }, + "responses": { + "200": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json index 8fd625202ae2..0448f2f9ecf3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/extensions.json @@ -1,393 +1,393 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2018-06-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring": { - "put": { - "tags": [ - "Extensions" - ], - "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/EnableLinuxClusterMonitoring.json" - } - }, - "operationId": "Extensions_EnableMonitoring", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterMonitoringRequest" - }, - "description": "The Operations Management Suite (OMS) workspace parameters." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Extensions" - ], - "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" - } - }, - "operationId": "Extensions_GetMonitoringStatus", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ClusterMonitoringResponse" - } - } - } - }, - "delete": { - "tags": [ - "Extensions" - ], - "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", - "x-ms-examples": { - "Enable cluster monitoring": { - "$ref": "./examples/DisableLinuxClusterMonitoring.json" - } - }, - "operationId": "Extensions_DisableMonitoring", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "OK response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { - "put": { - "tags": [ - "Extensions" - ], - "description": "Creates an HDInsight cluster extension.", - "operationId": "Extensions_Create", - "x-ms-examples": { - "Create a monitoring extension on Hadoop Linux cluster": { - "$ref": "./examples/CreateExtension.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Extension" - }, - "description": "The cluster extensions create request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Extensions" - ], - "description": "Gets the extension properties for the specified HDInsight cluster extension.", - "x-ms-examples": { - "Get an extension": { - "$ref": "./examples/GetExtension.json" - } - }, - "operationId": "Extensions_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Extension" - } - } - } - }, - "delete": { - "tags": [ - "Extensions" - ], - "description": "Deletes the specified extension for HDInsight cluster.", - "x-ms-examples": { - "Delete an extension": { - "$ref": "./examples/DeleteExtension.json" - } - }, - "operationId": "Extensions_Delete", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ExtensionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "Ok response definition." - }, - "202": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "Extension": { - "description": "Cluster monitoring extensions", - "properties": { - "workspaceId": { - "description": "The workspace ID for the cluster monitoring extension.", - "type": "string" - }, - "primaryKey": { - "description": "The certificate for the cluster monitoring extensions.", - "type": "string" - } - } - }, - "ClusterMonitoringResponse": { - "description": "The Operations Management Suite (OMS) status response", - "properties": { - "clusterMonitoringEnabled": { - "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", - "type": "boolean" - }, - "workspaceId": { - "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", - "type": "string" - } - } - }, - "ClusterMonitoringRequest": { - "description": "The Operations Management Suite (OMS) parameters.", - "properties": { - "workspaceId": { - "description": "The Operations Management Suite (OMS) workspace ID.", - "type": "string" - }, - "primaryKey": { - "description": "The Operations Management Suite (OMS) workspace key.", - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ExtensionNameParameter": { - "name": "extensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster extension.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/clustermonitoring": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/EnableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_EnableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMonitoringRequest" + }, + "description": "The Operations Management Suite (OMS) workspace parameters." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" + } + }, + "operationId": "Extensions_GetMonitoringStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClusterMonitoringResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/DisableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_DisableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Creates an HDInsight cluster extension.", + "operationId": "Extensions_Create", + "x-ms-examples": { + "Create a monitoring extension on Hadoop Linux cluster": { + "$ref": "./examples/CreateExtension.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "The cluster extensions create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the extension properties for the specified HDInsight cluster extension.", + "x-ms-examples": { + "Get an extension": { + "$ref": "./examples/GetExtension.json" + } + }, + "operationId": "Extensions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Extension" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Deletes the specified extension for HDInsight cluster.", + "x-ms-examples": { + "Delete an extension": { + "$ref": "./examples/DeleteExtension.json" + } + }, + "operationId": "Extensions_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Extension": { + "description": "Cluster monitoring extensions", + "properties": { + "workspaceId": { + "description": "The workspace ID for the cluster monitoring extension.", + "type": "string" + }, + "primaryKey": { + "description": "The certificate for the cluster monitoring extensions.", + "type": "string" + } + } + }, + "ClusterMonitoringResponse": { + "description": "The Operations Management Suite (OMS) status response", + "properties": { + "clusterMonitoringEnabled": { + "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "boolean" + }, + "workspaceId": { + "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", + "type": "string" + } + } + }, + "ClusterMonitoringRequest": { + "description": "The Operations Management Suite (OMS) parameters.", + "properties": { + "workspaceId": { + "description": "The Operations Management Suite (OMS) workspace ID.", + "type": "string" + }, + "primaryKey": { + "description": "The Operations Management Suite (OMS) workspace key.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster extension.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json index a69ff4e0f1ac..ecd6733b4eb8 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/locations.json @@ -1,150 +1,150 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2018-06-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.HDInsight/locations/{location}/usages": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Locations_ListUsages", - "description": "Lists the usages for the specified location.", - "x-ms-examples": { - "Get the subscription usages for specific location": { - "$ref": "./examples/GetHDInsightUsages.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LocationParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/UsagesListResult" - } - } - } - } - } - }, - "definitions": { - "LocalizedName": { - "description": "The details about the localizable name of a type of usage.", - "properties": { - "value": { - "description": "The name of the used resource.", - "type": "string" - }, - "localizedValue": { - "description": "The localized name of the used resource.", - "type": "string" - } - }, - "readOnly": true - }, - "Usage": { - "description": "The details about the usage of a particular limited resource.", - "properties": { - "unit": { - "description": "The type of measurement for usage.", - "type": "string" - }, - "currentValue": { - "description": "The current usage.", - "type": "integer" - }, - "limit": { - "description": "The maximum allowed usage.", - "type": "integer" - }, - "name": { - "description": "The details about the localizable name of the used resource.", - "$ref": "#/definitions/LocalizedName" - } - }, - "readOnly": true - }, - "UsagesListResult": { - "description": "The response for the operation to get regional usages for a subscription.", - "properties": { - "value": { - "description": "The list of usages.", - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - } - } - }, - "readOnly": true - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "LocationParameter": { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location to get capabilities for.", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-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.HDInsight/locations/{location}/usages": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListUsages", + "description": "Lists the usages for the specified location.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/GetHDInsightUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + } + } + } + }, + "definitions": { + "LocalizedName": { + "description": "The details about the localizable name of a type of usage.", + "properties": { + "value": { + "description": "The name of the used resource.", + "type": "string" + }, + "localizedValue": { + "description": "The localized name of the used resource.", + "type": "string" + } + }, + "readOnly": true + }, + "Usage": { + "description": "The details about the usage of a particular limited resource.", + "properties": { + "unit": { + "description": "The type of measurement for usage.", + "type": "string" + }, + "currentValue": { + "description": "The current usage.", + "type": "integer" + }, + "limit": { + "description": "The maximum allowed usage.", + "type": "integer" + }, + "name": { + "description": "The details about the localizable name of the used resource.", + "$ref": "#/definitions/LocalizedName" + } + }, + "readOnly": true + }, + "UsagesListResult": { + "description": "The response for the operation to get regional usages for a subscription.", + "properties": { + "value": { + "description": "The list of usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + } + }, + "readOnly": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to get capabilities for.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json index 20677800032d..c149bcf37d1b 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/scriptActions.json @@ -1,460 +1,460 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightManagementClient", - "description": "The HDInsight Management Client.", - "version": "2018-06-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - }], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}": { - "delete": { - "tags": [ - "ScriptActions" - ], - "operationId": "ScriptActions_Delete", - "description": "Deletes a specified persisted script action of the cluster.", - "x-ms-examples": { - "Delete a script action on HDInsight cluster": { - "$ref": "./examples/DeleteScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_ExecuteScriptActions", - "description": "Executes script actions on the specified HDInsight cluster.", - "x-ms-examples": { - "Execute script action on HDInsight cluster": { - "$ref": "./examples/PostExecuteScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" - }, - "description": "The parameters for executing script actions." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "202": { - "description": "OK response definition." - }, - "200": { - "description": "Accepted response definition." - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { - "get": { - "tags": [ - "ScriptActions" - ], - "operationId": "ScriptActions_ListByCluster", - "description": "Lists all the persisted script actions for the specified cluster.", - "x-ms-examples": { - "List all persisted script actions for the given cluster": { - "$ref": "./examples/GetLinuxHadoopScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ScriptActionsList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { - "get": { - "tags": [ - "ScriptExecutionHistory" - ], - "operationId": "ScriptActions_GetExecutionDetail", - "description": "Gets the script execution detail for the given script execution ID.", - "x-ms-examples": { - "Get script execution history by script id": { - "$ref": "./examples/GetScriptActionById.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptExecutionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { - "get": { - "tags": [ - "ScriptExecutionHistory" - ], - "operationId": "ScriptExecutionHistory_ListByCluster", - "description": "Lists all scripts' execution history for the specified cluster.", - "x-ms-examples": { - "Get Script Execution History List": { - "$ref": "./examples/GetScriptExecutionHistory.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/ScriptActionExecutionHistoryList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { - "post": { - "tags": [ - "Promote" - ], - "operationId": "ScriptExecutionHistory_Promote", - "description": "Promotes the specified ad-hoc script execution to a persisted script.", - "x-ms-examples": { - "Promote a script action on HDInsight cluster": { - "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ScriptExecutionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./operations.json#/definitions/ErrorResponse" - } - }, - "200": { - "description": "OK response definition." - } - } - } - } - }, - "definitions": { - "ScriptActionExecutionHistoryList": { - "description": "The list script execution history response.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - }, - "description": "The list of persisted script action details for the cluster." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - }, - "ClusterListRuntimeScriptActionDetailResult": { - "description": "The list runtime script action detail response.", - "properties": { - "value": { - "description": "The list of persisted script action details for the cluster.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - }, - "ScriptAction": { - "properties": { - "name": { - "type": "string", - "description": "The name of the script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script provided." - } - }, - "required": [ - "name", - "uri", - "parameters" - ], - "description": "Describes a script action on role on the cluster." - }, - "ScriptActionPersistedGetResponseSpec": { - "description": "The persisted script action for cluster.", - "properties": { - "name": { - "type": "string", - "description": "The name of script action." - }, - "uri": { - "type": "string", - "description": "The URI to the script." - }, - "parameters": { - "type": "string", - "description": "The parameters for the script provided." - }, - "roles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of roles where script will be executed." - }, - "applicationName": { - "type": "string", - "description": "The application name for the script action." - } - } - }, - "ScriptActionsList": { - "description": "The persisted script action for the cluster.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" - }, - "description": "The list of persisted script action details for the cluster." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "The link (url) to the next page of results." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster.", - "x-ms-parameter-location": "method" - }, - "ScriptNameParameter": { - "name": "scriptName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the script.", - "x-ms-parameter-location": "method" - }, - "ScriptExecutionIdParameter": { - "name": "scriptExecutionId", - "in": "path", - "required": true, - "type": "string", - "description": "The script execution Id", - "x-ms-parameter-location": "method" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The HDInsight client API Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2018-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [{ + "azure_auth": [ + "user_impersonation" + ] + }], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}": { + "delete": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_Delete", + "description": "Deletes a specified persisted script action of the cluster.", + "x-ms-examples": { + "Delete a script action on HDInsight cluster": { + "$ref": "./examples/DeleteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ExecuteScriptActions", + "description": "Executes script actions on the specified HDInsight cluster.", + "x-ms-examples": { + "Execute script action on HDInsight cluster": { + "$ref": "./examples/PostExecuteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" + }, + "description": "The parameters for executing script actions." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "OK response definition." + }, + "200": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { + "get": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_ListByCluster", + "description": "Lists all the persisted script actions for the specified cluster.", + "x-ms-examples": { + "List all persisted script actions for the given cluster": { + "$ref": "./examples/GetLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptActions_GetExecutionDetail", + "description": "Gets the script execution detail for the given script execution ID.", + "x-ms-examples": { + "Get script execution history by script id": { + "$ref": "./examples/GetScriptActionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptExecutionHistory_ListByCluster", + "description": "Lists all scripts' execution history for the specified cluster.", + "x-ms-examples": { + "Get Script Execution History List": { + "$ref": "./examples/GetScriptExecutionHistory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionExecutionHistoryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { + "post": { + "tags": [ + "Promote" + ], + "operationId": "ScriptExecutionHistory_Promote", + "description": "Promotes the specified ad-hoc script execution to a persisted script.", + "x-ms-examples": { + "Promote a script action on HDInsight cluster": { + "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + } + }, + "definitions": { + "ScriptActionExecutionHistoryList": { + "description": "The list script execution history response.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ClusterListRuntimeScriptActionDetailResult": { + "description": "The list runtime script action detail response.", + "properties": { + "value": { + "description": "The list of persisted script action details for the cluster.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ScriptAction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + } + }, + "required": [ + "name", + "uri", + "parameters" + ], + "description": "Describes a script action on role on the cluster." + }, + "ScriptActionPersistedGetResponseSpec": { + "description": "The persisted script action for cluster.", + "properties": { + "name": { + "type": "string", + "description": "The name of script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "type": "string", + "description": "The application name for the script action." + } + } + }, + "ScriptActionsList": { + "description": "The persisted script action for the cluster.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the script.", + "x-ms-parameter-location": "method" + }, + "ScriptExecutionIdParameter": { + "name": "scriptExecutionId", + "in": "path", + "required": true, + "type": "string", + "description": "The script execution Id", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } } \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json index 9b8bfcfa8e81..bd754b7bef94 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_routingendpointhealth.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "iotHubName": "testHub", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-04-01", - "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "endpointId": "id1", - "healthStatus": "healthy" - }, - { - "endpointId": "id2", - "healthStatus": "unknown" - } - ] - } - } - } +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json index 672c5f92d7c5..008177359549 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testallroutes.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "iotHubName": "testHub", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-04-01", - "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", - "input": { - "routingSource": "DeviceMessages", - "message": { - "body": "Body of message", - "appProperties": "App Properties", - "systemProperties": "System Properties" - } - } - }, - "responses": { - "200": { - "body": { - "routes": [ - { - "properties": { - "name": "Routeid", - "source": "DeviceMessages", - "endpointNames": ["id1"], - "isEnabled": true - } - } - ] - } - } - } +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": ["id1"], + "isEnabled": true + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json index d1012877cf2f..a7b6647d2d0f 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_testnewroute.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "iotHubName": "testHub", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-04-01", - "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", - "input": { - "message": { - "body": "Body of message", - "appProperties": "App Properties", - "systemProperties": "System Properties" - }, - "route": { - "name": "Routeid", - "source": "DeviceMessages", - "endpointNames": [ - "id1" - ], - "isEnabled": true - } - } - }, - "responses": { - "200": { - "body": { - "result": "false", - "details": { - "compilationErrors": [ - { - "message": "string response", - "severity": "error", - "location": { - "start": { - "line": 12, - "column": 12 - }, - "end": { - "line": 12, - "column": 24 - } - } - } - ] - } - } - } - } +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json index 316d5c3baff7..8d5ae3263932 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/examples/iothub_usages.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "api-version": "2018-04-01", - "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id" : "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", - "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", - "unit": "count", - "currentValue": 1, - "limit": 1, - "name": { - "value": "FreeHubCount", - "localizedValue": "Free Hub Count" - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id" : "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/DeletePartnerDetails.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/DeletePartnerDetails.json index 9a85bf5fd40d..96398e92064a 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/DeletePartnerDetails.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/DeletePartnerDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-02-01", "partnerId": "123456" diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetOperations.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetOperations.json index 7bfc696742fa..bb2234423a5b 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetOperations.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-02-01" }, diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetails.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetails.json index 47c13c1c487c..fba6832d17a1 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetails.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/GetPartnerDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-02-01", "partnerId": "123456" diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PatchPartnerDetails.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PatchPartnerDetails.json index 47c13c1c487c..fba6832d17a1 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PatchPartnerDetails.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PatchPartnerDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-02-01", "partnerId": "123456" diff --git a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PutPartnerDetails.json b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PutPartnerDetails.json index 47c13c1c487c..fba6832d17a1 100644 --- a/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PutPartnerDetails.json +++ b/specification/managementpartner/resource-manager/Microsoft.ManagementPartner/preview/2018-02-01/examples/PutPartnerDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-02-01", "partnerId": "123456" diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2015-10-01/media.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2015-10-01/media.json index 300c66244063..0dd24421734d 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2015-10-01/media.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2015-10-01/media.json @@ -1,942 +1,942 @@ -{ - "swagger": "2.0", - "info": { - "title": "MediaServicesManagementClient", - "description": "Media Services resource management APIs.", - "version": "2015-10-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Media/operations": { - "get": { - "operationId": "Operations_List", - "description": "Lists all of the available Media Services REST API operations.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "OperationsList": { "$ref": "./examples/OperationsList.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success. Returns a list of operations.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Media/CheckNameAvailability": { - "post": { - "operationId": "MediaService_CheckNameAvailability", - "description": "Checks whether the Media Service resource name is available. The name must be globally unique.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceCheckNameAvailability": { "$ref": "./examples/MediaServiceCheckNameAvailability.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "name": "parameters", - "description": "Properties needed to check the availability of a name.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityInput" - } - } - ], - "responses": { - "200": { - "description": "Success. Returns details about whether a Media Service resource name is available.", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityOutput" - }, - "examples": { - "application/json": { - "nameAvailable": false, - "reason": "AlreadyExists", - "message": "Already in use by another Media Service instance. Please try again with a name that is not likely to be in use." - } - } - }, - "default": { - "description": "CheckNameAvailability of a Media Service failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { - "get": { - "operationId": "MediaService_ListByResourceGroup", - "description": "Lists all of the Media Services in a resource group.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceListByResourceGroup": { "$ref": "./examples/MediaServiceListByResourceGroup.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "Success. Returns a list of all of the Media Services accounts in a resource group.", - "schema": { - "$ref": "#/definitions/MediaServiceCollection" - }, - "examples": { - "application/json": { - "value": [ - { - "name": "contosomedia", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", - "type": "Microsoft.Media/mediaservices", - "location": "West US", - "properties":{ - "apiEndpoints":[ - { - "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", - "majorVersion": "2" - } - ], - "storageAccounts":[ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - } - ] - } - } - ] - } - } - }, - "default": { - "description": "List Media Services failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}": { - "get": { - "operationId": "MediaService_Get", - "description": "Gets a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceGet": { "$ref": "./examples/MediaServiceGet.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success. Returns the details of the Media Services account.", - "schema": { - "$ref": "#/definitions/MediaService" - }, - "examples" : { - "application/json": { - "name": "contosomedia", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", - "type": "Microsoft.Media/mediaservices", - "location": "West US", - "properties":{ - "apiEndpoints":[ - { - "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", - "majorVersion": "2" - } - ], - "storageAccounts":[ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - } - ] - } - } - } - }, - "default": { - "description": "Get Media Services failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - }, - "put": { - "operationId": "MediaService_Create", - "description": "Creates a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceCreate": { "$ref": "./examples/MediaServiceCreate.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - }, - { - "name": "parameters", - "description": "Media Service properties needed for creation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MediaService" - } - } - ], - "responses": { - "201": { - "description": "Success. Returns the new Media Services account.", - "schema": { - "$ref": "#/definitions/MediaService" - }, - "examples" : { - "application/json": { - "name": "contosomedia", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", - "type": "Microsoft.Media/mediaservices", - "location": "West US", - "properties":{ - "apiEndpoints":[ - { - "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", - "majorVersion": "2" - } - ], - "storageAccounts":[ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - } - ] - } - } - } - }, - "default": { - "description": "Create Media Services failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - }, - "delete": { - "operationId": "MediaService_Delete", - "description": "Deletes a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceDelete": { "$ref": "./examples/MediaServiceDelete.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success. The Media Services account was deleted." - }, - "204": { - "description": "No Content. The account name does not exist." - }, - "default": { - "description": "Delete Media Services failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - }, - "patch": { - "operationId": "MediaService_Update", - "description": "Updates a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceUpdate": { "$ref": "./examples/MediaServiceUpdate.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - }, - { - "name": "parameters", - "description": "Media Service properties needed for update.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MediaService" - } - } - ], - "responses": { - "200": { - "description": "Success. The Media Services account was updated.", - "schema": { - "$ref": "#/definitions/MediaService" - }, - "examples" : { - "application/json": { - "name": "contosomedia", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", - "type": "Microsoft.Media/mediaservices", - "location": "West US", - "properties":{ - "apiEndpoints":[ - { - "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", - "majorVersion": "2" - } - ], - "storageAccounts":[ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - } - ] - } - } - } - }, - "default": { - "description": "Update Media Services failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/regenerateKey": { - "post": { - "operationId": "MediaService_RegenerateKey", - "description": "Regenerates a primary or secondary key for a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceRegenerateKey": { "$ref": "./examples/MediaServiceRegenerateKey.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - }, - { - "name": "parameters", - "description": "Properties needed to regenerate the Media Service key.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateKeyInput" - } - } - ], - "responses": { - "200": { - "description": "Success. The Media Services key specified in the input was regenerated.", - "schema": { - "$ref": "#/definitions/RegenerateKeyOutput" - }, - "examples": { - "application/json": { - "key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" - } - } - }, - "default": { - "description": "Regenerate Media Service key failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/listKeys": { - "post": { - "operationId": "MediaService_ListKeys", - "description": "Lists the keys for a Media Service.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceListKeys": { "$ref": "./examples/MediaServiceListKeys.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success. The keys for the Media Services account were listed.", - "schema": { - "$ref": "#/definitions/ServiceKeys" - }, - "examples":{ - "application/json": { - "primaryAuthEndpoint": "https://wamsprodglobal001acs.accesscontrol.windows.net/", - "secondaryAuthEndpoint": "https://wamsprodglobal002acs.accesscontrol.windows.net/", - "primaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", - "secondaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", - "scope": "urn:windowsazuremediaservices" - } - } - }, - "default": { - "description": "List Media Service keys failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/syncStorageKeys": { - "post": { - "operationId": "MediaService_SyncStorageKeys", - "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", - "externalDocs": { - "url": "https://aka.ms/media-manage" - }, - "x-ms-examples": { - "MediaServiceSyncStorageKeys": { "$ref": "./examples/MediaServiceSyncStorageKeys.json" } - }, - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/mediaResourceNameParameter" - }, - { - "name": "parameters", - "description": "Properties needed to synchronize the keys for a storage account to the Media Service.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SyncStorageKeysInput" - } - } - ], - "responses": { - "200": { - "description": "Success. The keys for the storage account were synchronized." - }, - "default": { - "description": "Synch Media Service storage keys failed.", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - } - } - } - }, - "definitions": { - "ApiEndpoint": { - "description": "The properties for a Media Services REST API endpoint.", - "example": { - "endpoint":"https://wamsbayclus001rest-hs.cloudapp.net/api/", - "majorVersion":"2" - }, - "properties": { - "endpoint": { - "description": "The Media Services REST endpoint.", - "type": "string" - }, - "majorVersion": { - "description": "The version of Media Services REST API.", - "type": "string" - } - } - }, - "ApiError": { - "description": "The error returned from a failed Media Services REST API call.", - "example": { - "error": { - "code": "BadRequest", - "message": "Name availability check is not supported for type Microsoft.Media/mediaservices." - } - }, - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message.", - "type": "string" - } - } - }, - "CheckNameAvailabilityInput": { - "description": "The request body for CheckNameAvailability API.", - "example": { - "name":"contosomedia", - "type":"mediaservices" - }, - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "description": "The name of the resource. A name must be globally unique.", - "type": "string", - "pattern": "^[a-z0-9]{3,24}$", - "minLength": 3, - "maxLength": 24 - }, - "type": { - "description": "The type of the resource - mediaservices.", - "$ref": "#/definitions/ResourceType" - } - } - }, - "ResourceType": { - "description": "Type of MediaService resource.", - "enum": [ - "mediaservices" - ], - "type": "string", - "x-ms-enum": { - "name": "ResourceType", - "modelAsString": false - } - }, - "CheckNameAvailabilityOutput": { - "description": "The response body for CheckNameAvailability API.", - "properties": { - "nameAvailable": { - "description": "Specifies if the name is available.", - "type": "boolean" - }, - "reason": { - "description": "Specifies the reason if the name is not available.", - "type": "string", - "enum": [ - "None", - "Invalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "EntityNameUnavailabilityReason", - "modelAsString": false - } - }, - "message": { - "description": "Specifies the detailed reason if the name is not available.", - "type": "string" - } - } - }, - "MediaService": { - "description": "The properties of a Media Service resource.", - "example": { - "location": "West US", - "properties": { - "storageAccounts": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - } - ] - } - }, - "properties": { - "properties": { - "description": "The additional properties of a Media Service resource.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/MediaServiceProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "MediaServiceCollection": { - "description": "The collection of Media Service resources.", - "properties": { - "value": { - "description": "The collection of Media Service resources.", - "type": "array", - "items": { - "$ref": "#/definitions/MediaService" - } - } - } - }, - "MediaServiceProperties": { - "description": "The additional properties of a Media Service resource.", - "properties": { - "apiEndpoints": { - "description": "Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ApiEndpoint" - } - }, - "storageAccounts": { - "description": "The storage accounts for this resource.", - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - } - } - } - }, - "RegenerateKeyInput": { - "description": "The request body for a RegenerateKey API.", - "example": { - "keyType": "Primary" - }, - "properties": { - "keyType": { - "description": "The keyType indicating which key you want to regenerate, Primary or Secondary.", - "type": "string", - "enum": [ - "Primary", - "Secondary" - ], - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - } - }, - "required": [ - "keyType" - ] - }, - "RegenerateKeyOutput": { - "description": "The response body for a RegenerateKey API.", - "example": { - "key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" - }, - "properties": { - "key": { - "description": "The new value of either the primary or secondary key.", - "type": "string" - } - } - }, - "Resource": { - "description": "The Azure Resource Manager resource.", - "properties": { - "id": { - "description": "The id of the resource.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the resource.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "The type of the resource", - "readOnly": true, - "type": "string" - }, - "location": { - "type": "string", - "description": "The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth)." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Tags to help categorize the resource in the Azure portal." - } - }, - "x-ms-azure-resource": true - }, - "ServiceKeys": { - "description": "The response body for a ListKeys API.", - "example": { - "primaryAuthEndpoint": "https://wamsprodglobal001acs.accesscontrol.windows.net/", - "secondaryAuthEndpoint": "https://wamsprodglobal002acs.accesscontrol.windows.net/", - "primaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", - "secondaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", - "scope": "urn:windowsazuremediaservices" - }, - "properties": { - "primaryAuthEndpoint": { - "description": "The primary authorization endpoint.", - "type": "string" - }, - "secondaryAuthEndpoint": { - "description": "The secondary authorization endpoint.", - "type": "string" - }, - "primaryKey": { - "description": "The primary key for the Media Service resource.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary key for the Media Service resource.", - "type": "string" - }, - "scope": { - "description": "The authorization scope.", - "type": "string" - } - } - }, - "StorageAccount": { - "description": "The properties of a storage account associated with this resource.", - "example": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", - "isPrimary": true - }, - "required": [ - "id", - "isPrimary" - ], - "properties": { - "id": { - "description": "The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false).", - "type": "string" - }, - "isPrimary": { - "description": "Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false.", - "type": "boolean" - } - } - }, - "SyncStorageKeysInput": { - "description": "The request body for a SyncStorageKeys API.", - "example": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia" - }, - "required": [ - "id" - ], - "properties": { - "id": { - "description": "The id of the storage account resource.", - "type": "string" - } - } - }, - "OperationListResult": { - "description": "Result of the request to list Media Services operations.", - "properties": { - "value": { - "description": "List of Media Services operations supported by the Microsoft.Media resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "A Media Services REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string", - "readOnly": true - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Media", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource on which the operation is performed: Invoice, etc.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string", - "readOnly": true - } - } - } - } - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "description": "The unique identifier for a Microsoft Azure subscription.", - "in": "path", - "required": true, - "type": "string" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "description": "Name of the resource group within the Azure subscription.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "mediaResourceNameParameter": { - "name": "mediaServiceName", - "description": "Name of the Media Service.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-z0-9]{3,24}$", - "minLength": 3, - "maxLength": 24, - "x-ms-parameter-location": "method" - }, - "apiVersionParameter": { - "name": "api-version", - "description": "Version of the API to be used with the client request. The current version is 2015-10-01.", - "in": "query", - "required": true, - "type": "string" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "MediaServicesManagementClient", + "description": "Media Services resource management APIs.", + "version": "2015-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Media/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Media Services REST API operations.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "OperationsList": { "$ref": "./examples/OperationsList.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. Returns a list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/CheckNameAvailability": { + "post": { + "operationId": "MediaService_CheckNameAvailability", + "description": "Checks whether the Media Service resource name is available. The name must be globally unique.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceCheckNameAvailability": { "$ref": "./examples/MediaServiceCheckNameAvailability.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "description": "Properties needed to check the availability of a name.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + } + ], + "responses": { + "200": { + "description": "Success. Returns details about whether a Media Service resource name is available.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + }, + "examples": { + "application/json": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Already in use by another Media Service instance. Please try again with a name that is not likely to be in use." + } + } + }, + "default": { + "description": "CheckNameAvailability of a Media Service failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { + "get": { + "operationId": "MediaService_ListByResourceGroup", + "description": "Lists all of the Media Services in a resource group.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceListByResourceGroup": { "$ref": "./examples/MediaServiceListByResourceGroup.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. Returns a list of all of the Media Services accounts in a resource group.", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + }, + "examples": { + "application/json": { + "value": [ + { + "name": "contosomedia", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", + "type": "Microsoft.Media/mediaservices", + "location": "West US", + "properties":{ + "apiEndpoints":[ + { + "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", + "majorVersion": "2" + } + ], + "storageAccounts":[ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + } + ] + } + } + ] + } + } + }, + "default": { + "description": "List Media Services failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}": { + "get": { + "operationId": "MediaService_Get", + "description": "Gets a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceGet": { "$ref": "./examples/MediaServiceGet.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. Returns the details of the Media Services account.", + "schema": { + "$ref": "#/definitions/MediaService" + }, + "examples" : { + "application/json": { + "name": "contosomedia", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", + "type": "Microsoft.Media/mediaservices", + "location": "West US", + "properties":{ + "apiEndpoints":[ + { + "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", + "majorVersion": "2" + } + ], + "storageAccounts":[ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + } + ] + } + } + } + }, + "default": { + "description": "Get Media Services failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + }, + "put": { + "operationId": "MediaService_Create", + "description": "Creates a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceCreate": { "$ref": "./examples/MediaServiceCreate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + }, + { + "name": "parameters", + "description": "Media Service properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + } + } + ], + "responses": { + "201": { + "description": "Success. Returns the new Media Services account.", + "schema": { + "$ref": "#/definitions/MediaService" + }, + "examples" : { + "application/json": { + "name": "contosomedia", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", + "type": "Microsoft.Media/mediaservices", + "location": "West US", + "properties":{ + "apiEndpoints":[ + { + "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", + "majorVersion": "2" + } + ], + "storageAccounts":[ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + } + ] + } + } + } + }, + "default": { + "description": "Create Media Services failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + }, + "delete": { + "operationId": "MediaService_Delete", + "description": "Deletes a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceDelete": { "$ref": "./examples/MediaServiceDelete.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The Media Services account was deleted." + }, + "204": { + "description": "No Content. The account name does not exist." + }, + "default": { + "description": "Delete Media Services failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + }, + "patch": { + "operationId": "MediaService_Update", + "description": "Updates a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceUpdate": { "$ref": "./examples/MediaServiceUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + }, + { + "name": "parameters", + "description": "Media Service properties needed for update.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + } + } + ], + "responses": { + "200": { + "description": "Success. The Media Services account was updated.", + "schema": { + "$ref": "#/definitions/MediaService" + }, + "examples" : { + "application/json": { + "name": "contosomedia", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia", + "type": "Microsoft.Media/mediaservices", + "location": "West US", + "properties":{ + "apiEndpoints":[ + { + "endpoint": "https://wamsbayclus001rest-hs.cloudapp.net/api/", + "majorVersion": "2" + } + ], + "storageAccounts":[ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + } + ] + } + } + } + }, + "default": { + "description": "Update Media Services failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/regenerateKey": { + "post": { + "operationId": "MediaService_RegenerateKey", + "description": "Regenerates a primary or secondary key for a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceRegenerateKey": { "$ref": "./examples/MediaServiceRegenerateKey.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + }, + { + "name": "parameters", + "description": "Properties needed to regenerate the Media Service key.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyInput" + } + } + ], + "responses": { + "200": { + "description": "Success. The Media Services key specified in the input was regenerated.", + "schema": { + "$ref": "#/definitions/RegenerateKeyOutput" + }, + "examples": { + "application/json": { + "key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" + } + } + }, + "default": { + "description": "Regenerate Media Service key failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/listKeys": { + "post": { + "operationId": "MediaService_ListKeys", + "description": "Lists the keys for a Media Service.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceListKeys": { "$ref": "./examples/MediaServiceListKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The keys for the Media Services account were listed.", + "schema": { + "$ref": "#/definitions/ServiceKeys" + }, + "examples":{ + "application/json": { + "primaryAuthEndpoint": "https://wamsprodglobal001acs.accesscontrol.windows.net/", + "secondaryAuthEndpoint": "https://wamsprodglobal002acs.accesscontrol.windows.net/", + "primaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", + "secondaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", + "scope": "urn:windowsazuremediaservices" + } + } + }, + "default": { + "description": "List Media Service keys failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{mediaServiceName}/syncStorageKeys": { + "post": { + "operationId": "MediaService_SyncStorageKeys", + "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", + "externalDocs": { + "url": "https://aka.ms/media-manage" + }, + "x-ms-examples": { + "MediaServiceSyncStorageKeys": { "$ref": "./examples/MediaServiceSyncStorageKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/mediaResourceNameParameter" + }, + { + "name": "parameters", + "description": "Properties needed to synchronize the keys for a storage account to the Media Service.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncStorageKeysInput" + } + } + ], + "responses": { + "200": { + "description": "Success. The keys for the storage account were synchronized." + }, + "default": { + "description": "Synch Media Service storage keys failed.", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + } + } + } + }, + "definitions": { + "ApiEndpoint": { + "description": "The properties for a Media Services REST API endpoint.", + "example": { + "endpoint":"https://wamsbayclus001rest-hs.cloudapp.net/api/", + "majorVersion":"2" + }, + "properties": { + "endpoint": { + "description": "The Media Services REST endpoint.", + "type": "string" + }, + "majorVersion": { + "description": "The version of Media Services REST API.", + "type": "string" + } + } + }, + "ApiError": { + "description": "The error returned from a failed Media Services REST API call.", + "example": { + "error": { + "code": "BadRequest", + "message": "Name availability check is not supported for type Microsoft.Media/mediaservices." + } + }, + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "The request body for CheckNameAvailability API.", + "example": { + "name":"contosomedia", + "type":"mediaservices" + }, + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The name of the resource. A name must be globally unique.", + "type": "string", + "pattern": "^[a-z0-9]{3,24}$", + "minLength": 3, + "maxLength": 24 + }, + "type": { + "description": "The type of the resource - mediaservices.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "ResourceType": { + "description": "Type of MediaService resource.", + "enum": [ + "mediaservices" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false + } + }, + "CheckNameAvailabilityOutput": { + "description": "The response body for CheckNameAvailability API.", + "properties": { + "nameAvailable": { + "description": "Specifies if the name is available.", + "type": "boolean" + }, + "reason": { + "description": "Specifies the reason if the name is not available.", + "type": "string", + "enum": [ + "None", + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "EntityNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "Specifies the detailed reason if the name is not available.", + "type": "string" + } + } + }, + "MediaService": { + "description": "The properties of a Media Service resource.", + "example": { + "location": "West US", + "properties": { + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + } + ] + } + }, + "properties": { + "properties": { + "description": "The additional properties of a Media Service resource.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MediaServiceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "MediaServiceCollection": { + "description": "The collection of Media Service resources.", + "properties": { + "value": { + "description": "The collection of Media Service resources.", + "type": "array", + "items": { + "$ref": "#/definitions/MediaService" + } + } + } + }, + "MediaServiceProperties": { + "description": "The additional properties of a Media Service resource.", + "properties": { + "apiEndpoints": { + "description": "Read-only property that lists the Media Services REST API endpoints for this resource. If supplied on a PUT or PATCH, the value will be ignored.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApiEndpoint" + } + }, + "storageAccounts": { + "description": "The storage accounts for this resource.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "RegenerateKeyInput": { + "description": "The request body for a RegenerateKey API.", + "example": { + "keyType": "Primary" + }, + "properties": { + "keyType": { + "description": "The keyType indicating which key you want to regenerate, Primary or Secondary.", + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ] + }, + "RegenerateKeyOutput": { + "description": "The response body for a RegenerateKey API.", + "example": { + "key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" + }, + "properties": { + "key": { + "description": "The new value of either the primary or secondary key.", + "type": "string" + } + } + }, + "Resource": { + "description": "The Azure Resource Manager resource.", + "properties": { + "id": { + "description": "The id of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the resource", + "readOnly": true, + "type": "string" + }, + "location": { + "type": "string", + "description": "The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth)." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags to help categorize the resource in the Azure portal." + } + }, + "x-ms-azure-resource": true + }, + "ServiceKeys": { + "description": "The response body for a ListKeys API.", + "example": { + "primaryAuthEndpoint": "https://wamsprodglobal001acs.accesscontrol.windows.net/", + "secondaryAuthEndpoint": "https://wamsprodglobal002acs.accesscontrol.windows.net/", + "primaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", + "secondaryKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=", + "scope": "urn:windowsazuremediaservices" + }, + "properties": { + "primaryAuthEndpoint": { + "description": "The primary authorization endpoint.", + "type": "string" + }, + "secondaryAuthEndpoint": { + "description": "The secondary authorization endpoint.", + "type": "string" + }, + "primaryKey": { + "description": "The primary key for the Media Service resource.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key for the Media Service resource.", + "type": "string" + }, + "scope": { + "description": "The authorization scope.", + "type": "string" + } + } + }, + "StorageAccount": { + "description": "The properties of a storage account associated with this resource.", + "example": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia", + "isPrimary": true + }, + "required": [ + "id", + "isPrimary" + ], + "properties": { + "id": { + "description": "The id of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts (isPrimary false).", + "type": "string" + }, + "isPrimary": { + "description": "Is this storage account resource the primary storage account for the Media Service resource. Blob only storage must set this to false.", + "type": "boolean" + } + } + }, + "SyncStorageKeysInput": { + "description": "The request body for a SyncStorageKeys API.", + "example": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Storage/storageAccounts/contosomedia" + }, + "required": [ + "id" + ], + "properties": { + "id": { + "description": "The id of the storage account resource.", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Media Services operations.", + "properties": { + "value": { + "description": "List of Media Services operations supported by the Microsoft.Media resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Media Services REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Media", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Invoice, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "description": "The unique identifier for a Microsoft Azure subscription.", + "in": "path", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "Name of the resource group within the Azure subscription.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "mediaResourceNameParameter": { + "name": "mediaServiceName", + "description": "Name of the Media Service.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9]{3,24}$", + "minLength": 3, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "apiVersionParameter": { + "name": "api-version", + "description": "Version of the API to be used with the client request. The current version is 2015-10-01.", + "in": "query", + "required": true, + "type": "string" + } + } +} diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json index 37e8a5ae62c4..8dbc8df139dd 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json @@ -524,4 +524,4 @@ "description": "Client Api Version." } } -} +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerList.json index d9afcf4dab9d..ca2c00b01b1e 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerList.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-12-01", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterCreate.json index f175d03759a0..f73d69769f68 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterCreate.json @@ -93,4 +93,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterGet.json index 4dcfae1faa0d..b471bf6cb42f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterGet.json @@ -39,4 +39,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterList.json index befdd247f958..73f5556c297b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterList.json @@ -41,4 +41,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterListByResourceGroup.json index 29a613cc2c40..d63663db1ab0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterListByResourceGroup.json @@ -42,4 +42,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleCreate.json index 40266d38639d..030e779ba49e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleCreate.json @@ -59,4 +59,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleGet.json index 1cd1e991a53c..1622246d75e6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleGet.json @@ -27,4 +27,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleListByRouteFilter.json index ab3a66670b44..e0d972a3a211 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleListByRouteFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleListByRouteFilter.json @@ -30,4 +30,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleUpdate.json index 761ed4f0fa1a..4983abbe370b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterRuleUpdate.json @@ -40,4 +40,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterUpdate.json index 8ca544d25684..fba7e86e63de 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/RouteFilterUpdate.json @@ -57,4 +57,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/ServiceCommunityList.json index 0980c1a355cd..888e220d1579 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/ServiceCommunityList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/examples/ServiceCommunityList.json @@ -49,4 +49,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/routeFilter.json index cc573f726e41..e0c2abcaf1f1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/routeFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/routeFilter.json @@ -813,4 +813,4 @@ } } } - + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/serviceCommunity.json index b9b2695910cc..3dace89d602c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/serviceCommunity.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/serviceCommunity.json @@ -155,4 +155,4 @@ } } } - + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterCreate.json index f7e68ba5c825..c1da784498d1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterCreate.json @@ -93,4 +93,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterGet.json index 9943b9903aa1..80d077c351e7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterGet.json @@ -39,4 +39,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterList.json index d3fbbe60c93f..2e45f9843bec 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterList.json @@ -41,4 +41,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterListByResourceGroup.json index 7de73b32d5ae..479b36876cec 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterListByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterListByResourceGroup.json @@ -42,4 +42,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleCreate.json index b87907b1d58e..da317737cd58 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleCreate.json @@ -59,4 +59,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleGet.json index 753a5eb3666d..4a31959f1f8f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleGet.json @@ -27,4 +27,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleListByRouteFilter.json index b273ec24e001..1231524c3fe0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleListByRouteFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleListByRouteFilter.json @@ -30,4 +30,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleUpdate.json index 1190e0a21f5e..616607553cd8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterRuleUpdate.json @@ -40,4 +40,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterUpdate.json index 9f8388d439b5..87321baf9cc8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/RouteFilterUpdate.json @@ -57,4 +57,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/ServiceCommunityList.json index bcb3af2f4af6..7c508c820777 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/ServiceCommunityList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/ServiceCommunityList.json @@ -49,4 +49,4 @@ } } } -} +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpGet.json index 0eec737f95dc..c2d17748c67e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpGet.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "virtualMachineScaleSetName": "vmss1", - "resourceGroupName": "vmss-tester", - "api-version": "2017-03-30", - "subscriptionId": "subid", - "virtualmachineIndex": 1, - "networkInterfaceName": "nic1", - "ipConfigurationName": "ip1", - "publicIpAddressName": "pub1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", - "name": "pub1", - "publicIPAllocationMethod": "Dynamic", - "publicIPAddressVersion": "IPv4", - "ipConfiguration": { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - }, - "dnsSettings": { - "domainNameLabel": "vm1.testvmssacc", - "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" - }, - "ipAddress": "13.67.119.72", - "idleTimeoutInMinutes": 10, - "provisioningState": "Succeeded" - } - } - } +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpListAll.json index 1afab9fc0f03..1b670ed5f772 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssPublicIpListAll.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "virtualMachineScaleSetName": "vmss1", - "resourceGroupName": "vmss-tester", - "api-version": "2017-03-30", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", - "name": "pub1", - "publicIPAllocationMethod": "Dynamic", - "publicIPAddressVersion": "IPv4", - "ipConfiguration": { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - }, - "dnsSettings": { - "domainNameLabel": "vm1.testvmssacc", - "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" - }, - "ipAddress": "13.67.119.72", - "idleTimeoutInMinutes": 10, - "provisioningState": "Succeeded" - }, - { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", - "name": "pub1", - "publicIPAllocationMethod": "Dynamic", - "publicIPAddressVersion": "IPv4", - "ipConfiguration": { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" - }, - "dnsSettings": { - "domainNameLabel": "vm3.testvmssacc", - "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" - }, - "ipAddress": "13.67.118.216", - "idleTimeoutInMinutes": 10, - "provisioningState": "Succeeded" - } - ] - } - } - } +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssVmPublicIpList.json index ff8e82b8b497..a567cafd8039 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssVmPublicIpList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/examples/VmssVmPublicIpList.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "virtualMachineScaleSetName": "vmss1", - "resourceGroupName": "vmss-tester", - "api-version": "2017-03-30", - "subscriptionId": "subid", - "virtualmachineIndex": 1, - "networkInterfaceName": "nic1", - "ipConfigurationName": "ip1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", - "name": "pub1", - "publicIPAllocationMethod": "Dynamic", - "publicIPAddressVersion": "IPv4", - "ipConfiguration": { - "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - }, - "dnsSettings": { - "domainNameLabel": "vm1.testvmssacc", - "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" - }, - "ipAddress": "13.67.119.72", - "idleTimeoutInMinutes": 10, - "provisioningState": "Succeeded" - } - ] - } - } - } +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/routeFilter.json index 68221073ac1f..1c5189f375ed 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/routeFilter.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/routeFilter.json @@ -813,4 +813,4 @@ } } } - + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/serviceCommunity.json index 677f5c500aba..85ba56987e4d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/serviceCommunity.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/serviceCommunity.json @@ -155,4 +155,4 @@ } } } - + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetwork.json index ce36b5abefe0..5f419a17a365 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetwork.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetwork.json @@ -1108,4 +1108,4 @@ } } } - + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json index 86b3d7b0bb4a..79113ac031f9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json @@ -1,261 +1,261 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2017-03-30" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { - "get": { - "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", - "description": "Gets information about all public IP addresses on a virtual machine scale set level.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "virtualMachineScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine scale set." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "2017-03-30" - ], - "x-ms-enum": { - "name": "ApiVersion", - "modelAsString": true - }, - "description": "Client API version." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of PublicIPInterface resources.", - "schema": { - "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" - } - } - }, - "x-ms-examples": { - "ListVMSSPublicIP": { "$ref": "./examples/VmssPublicIpListAll.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses" : { - "get": { - "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", - "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "virtualMachineScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine scale set." - }, - { - "name": "virtualmachineIndex", - "in": "path", - "required": true, - "type": "string", - "description": "The virtual machine index." - }, - { - "name": "networkInterfaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The network interface name." - }, - { - "name": "ipConfigurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The IP configuration name." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "2017-03-30" - ], - "x-ms-enum": { - "name": "ApiVersion", - "modelAsString": true - }, - "description": "Client API version." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of PublicIPAddress resources.", - "schema": { - "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" - } - } - }, - "x-ms-examples": { - "ListVMSSVMPublicIP": { "$ref": "./examples/VmssVmPublicIpList.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { - "get": { - "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", - "description": "Get the specified public IP address in a virtual machine scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "virtualMachineScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine scale set." - }, - { - "name": "virtualmachineIndex", - "in": "path", - "required": true, - "type": "string", - "description": "The virtual machine index." - }, - { - "name": "networkInterfaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the network interface." - }, - { - "name": "ipConfigurationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the IP configuration." - }, - { - "name": "publicIpAddressName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the public IP Address." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "2017-03-30" - ], - "x-ms-enum": { - "name": "ApiVersion", - "modelAsString": true - }, - "description": "Client API version." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "Expands referenced resources." - } - ], - "x-ms-examples": { - "GetVMSSPublicIP": { "$ref": "./examples/VmssPublicIpGet.json" } - }, - "responses": { - "200": { - "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", - "schema": { - "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" - } - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - } - } +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { "$ref": "./examples/VmssPublicIpListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses" : { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { "$ref": "./examples/VmssVmPublicIpList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { "$ref": "./examples/VmssPublicIpGet.json" } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/endpointService.json index 5eb27c65cf49..de106badbeb6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/endpointService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/endpointService.json @@ -1,127 +1,127 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2017-06-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { - "get": { - "operationId": "AvailableEndpointServices_List", - "description": "List what values of endpoint services are available for use.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location to check available endpoint services." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns list of available endpoint services.", - "schema": { - "$ref": "#/definitions/EndpointServicesListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } - } - } - } - }, - "definitions": { - "EndpointServicesListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EndpointServiceResult" - }, - "description": "List of available endpoint services in a region." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." - } - }, - "description": "Response for the ListAvailableEndpointServices API service call." - }, - "EndpointServiceResult": { - "properties": { - "name": { - "type": "string", - "description": "Name of the endpoint service.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Type of the endpoint service.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/SubResource" - } - ], - "description": "Endpoint service." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/CheckDnsNameAvailability.json index 90b817966ff7..9e69e87f7cfb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/CheckDnsNameAvailability.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/CheckDnsNameAvailability.json @@ -1,15 +1,15 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "location" : "westus", - "domainNameLabel" : "testdns" - }, - "responses" : { - "200" : { - "body": { - "available": false - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "location" : "westus", + "domainNameLabel" : "testdns" + }, + "responses" : { + "200" : { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleGet.json index ee28800e3b91..3ff0747e80e9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleGet.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "networkSecurityGroupName": "nsg1", - "defaultSecurityRuleName": "AllowVnetInBound" - }, - "responses": { - "200": { - "body": { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - } - } - } -} +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleList.json index 1d77c51f00ae..1f4f288dfad1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/DefaultSecurityRuleList.json @@ -1,136 +1,136 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "networkSecurityGroupName": "nsg1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound", - "sourcePortRanges": [], - "destinationPortRanges": [], - "sourceAddressPrefixes": [], - "destinationAddressPrefixes": [] - } - } - ] - } - } - } -} +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/EndpointServicesList.json index 38e9517ec4eb..c3ed844890d7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/EndpointServicesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/EndpointServicesList.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "location": "westus", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.Storage", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - }, - { - "name": "Microsoft.Sql", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - }, - { - "name": "Microsoft.AzureActiveDirectory", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - } - ] - } - } - } +{ + "parameters": { + "location": "westus", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleCreate.json index dd788486208e..962831df6c78 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleCreate.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "loadBalancerName": "lb1", - "inboundNatRuleName": "natRule1.1", - "inboundNatRuleParameters": { - "properties": { - "protocol": "Tcp", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3390, - "backendPort": 3389, - "idleTimeoutInMinutes": 4, - "enableFloatingIP": false - } - } - }, - "responses": { - "200": { - "body": { - "name": "natRule1.1", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3390, - "backendPort": 3389, - "enableFloatingIP": false, - "idleTimeoutInMinutes": 4, - "protocol": "Tcp", - "backendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - } - } - } - }, - "201": { - "body": { - "name": "natRule1.1", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3390, - "backendPort": 3389, - "enableFloatingIP": false, - "idleTimeoutInMinutes": 4, - "protocol": "Tcp", - "backendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - } - } - } - } - } +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleDelete.json index 348ec147a520..69c143a62b85 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "loadBalancerName": "lb1", - "inboundNatRuleName": "natRule1.1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleGet.json index 13ffaa1523a5..94ad9810867a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleGet.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "loadBalancerName": "lb1", - "inboundNatRuleName": "natRule1.1" - }, - "responses": { - "200": { - "body": { - "name": "natRule1.1", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3390, - "backendPort": 3389, - "enableFloatingIP": false, - "idleTimeoutInMinutes": 4, - "protocol": "Tcp", - "backendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - } - } - } - } - } -} +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleList.json index a01098a29a6b..67a9bec3efcb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/InboundNatRuleList.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "resourceGroupName": "testrg", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "loadBalancerName": "lb1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "natRule1.1", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3390, - "backendPort": 3389, - "enableFloatingIP": false, - "idleTimeoutInMinutes": 4, - "protocol": "Tcp", - "backendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" - } - } - }, - { - "name": "natRule1.3", - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" - }, - "frontendPort": 3392, - "backendPort": 3389, - "enableFloatingIP": false, - "idleTimeoutInMinutes": 4, - "protocol": "Tcp", - "backendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" - } - } - } - ] - } - } - } -} +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreate.json index 9bb7dab86481..044b9583a2fd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreate.json @@ -1,324 +1,324 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "properties": { - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "properties": { - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "properties": { - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "properties": { - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "inboundNatPools": [], - "outboundNatRules": [] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - }, - "201" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreateWithZones.json index 1353ec8361eb..3ab3d29d96dd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreateWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerCreateWithZones.json @@ -1,335 +1,335 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "properties": { - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "properties": { - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - }, - "zones": [ "1" ] - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "properties": { - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "properties": { - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "inboundNatPools": [], - "outboundNatRules": [] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - }, - "201" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + }, + "zones": [ "1" ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerDelete.json index eeea3a0ce9a6..933dfd39aace 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerGet.json index 72e36ec3032a..3f0cd497d600 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerGet.json @@ -1,121 +1,121 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb" - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerList.json index 379e749bc9fb..9714d093160d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerList.json @@ -1,140 +1,140 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "felb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "belb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration":{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" - } - } - } - ], - "probes": [ - { - "name": "prlb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "inrlb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - }, - { - "name": "lb2", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [], - "backendAddressPools": [], - "loadBalancingRules": [], - "probes": [], - "inboundNatRules": [], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerListAll.json index 206383b77cee..913e7603d8b8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/LoadBalancerListAll.json @@ -1,139 +1,139 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "felb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "belb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration":{ - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" - } - } - } - ], - "probes": [ - { - "name": "prlb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "inrlb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - }, - { - "name": "lb3", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [], - "backendAddressPools": [], - "loadBalancingRules": [], - "probes": [], - "inboundNatRules": [], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceCreate.json index df70210f1598..e00a0d183dd6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceCreate.json @@ -1,98 +1,98 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "test-nic", - "parameters": { - "properties": { - "enableAcceleratedNetworking": true, - "ipConfigurations": [ - { - "name": "ipconfig1", - "properties": { - "publicIPAddress": { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet": { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - } - } - } - ] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - }, - "201" : { - "body" : { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + }, + "201" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceDelete.json index e1d018b013a7..09c717130871 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "test-nic" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveNSGList.json index 188da0c4a678..1f38ecf381c3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveNSGList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -1,71 +1,71 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "nic1" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "networkSecurityGroup" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" - }, - "association" : { - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "networkInterface" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" - } - }, - "effectiveSecurityRules" : [ - { - "name" : "securityRules/rule1", - "protocol" : "Tcp", - "sourcePortRange" : "456-456", - "destinationPortRange" : "6579-6579", - "sourceAddressPrefix" : "0.0.0.0/32", - "destinationAddressPrefix" : "0.0.0.0/32", - "access" : "Allow", - "priority" : 234, - "direction" : "Inbound" - }, - { - "name" : "securityRules/default-allow-rdp", - "protocol" : "Tcp", - "sourcePortRange" : "0-65535", - "destinationPortRange" : "3389-3389", - "sourceAddressPrefix" : "1.1.1.1/32", - "destinationAddressPrefix" : "0.0.0.0/0", - "access" : "Allow", - "priority" : 1000, - "direction" : "Inbound" - }, - { - "name" : "defaultSecurityRules/AllowInternetOutBound", - "protocol" : "All", - "sourcePortRange" : "0-65535", - "destinationPortRange" : "0-65535", - "sourceAddressPrefix" : "0.0.0.0/0", - "destinationAddressPrefix" : "Internet", - "expandedDestinationAddressPrefix" : [ - "32.0.0.0/3", - "4.0.0.0/6", - "2.0.0.0/7", - "1.0.0.0/8" - ], - "access" : "Allow", - "priority" : 65001, - "direction" : "Outbound" - } - ] - } - ] - } - }, - "202" : { } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association" : { + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules" : [ + { + "name" : "securityRules/rule1", + "protocol" : "Tcp", + "sourcePortRange" : "456-456", + "destinationPortRange" : "6579-6579", + "sourceAddressPrefix" : "0.0.0.0/32", + "destinationAddressPrefix" : "0.0.0.0/32", + "access" : "Allow", + "priority" : 234, + "direction" : "Inbound" + }, + { + "name" : "securityRules/default-allow-rdp", + "protocol" : "Tcp", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "3389-3389", + "sourceAddressPrefix" : "1.1.1.1/32", + "destinationAddressPrefix" : "0.0.0.0/0", + "access" : "Allow", + "priority" : 1000, + "direction" : "Inbound" + }, + { + "name" : "defaultSecurityRules/AllowInternetOutBound", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "0.0.0.0/0", + "destinationAddressPrefix" : "Internet", + "expandedDestinationAddressPrefix" : [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access" : "Allow", + "priority" : 65001, + "direction" : "Outbound" + } + ] + } + ] + } + }, + "202" : { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveRouteTableList.json index c2a44fbaccd1..344c7d07589c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveRouteTableList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -1,71 +1,71 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "nic1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "172.20.2.0/24" - ], - "nextHopType": "VnetLocal", - "nextHopIpAddress": [] - }, - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "0.0.0.0/0" - ], - "nextHopType": "Internet", - "nextHopIpAddress": [] - }, - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "10.0.0.0/8" - ], - "nextHopType": "None", - "nextHopIpAddress": [] - }, - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "100.64.0.0/10" - ], - "nextHopType": "None", - "nextHopIpAddress": [] - }, - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "172.16.0.0/12" - ], - "nextHopType": "None", - "nextHopIpAddress": [] - }, - { - "source": "Default", - "state": "Active", - "addressPrefix": [ - "192.168.0.0/16" - ], - "nextHopType": "None", - "nextHopIpAddress": [] - } - ] - } - }, - "202" : { } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202" : { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceGet.json index 104d0b652f9a..a49cafab64eb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceGet.json @@ -1,54 +1,54 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "test-nic" - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [], - "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" - }, - "macAddress" : "00-0D-3A-1B-C7-21", - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false, - "networkSecurityGroup" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" - }, - "primary" : true, - "virtualMachine" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" - } - }, - "type" : "Microsoft.Network/networkInterfaces" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceList.json index cd8d5b0e1869..508cfa4b27c1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceList.json @@ -1,90 +1,90 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [], - "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" - }, - "macAddress" : "00-0D-3A-1B-C7-21", - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false, - "networkSecurityGroup" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" - }, - "primary" : true, - "virtualMachine" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" - } - }, - "type" : "Microsoft.Network/networkInterfaces" - }, - { - "name" : "test-nic2", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - ] - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceListAll.json index 66ce05f79bae..7adbb8ee48cd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkInterfaceListAll.json @@ -1,89 +1,89 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [], - "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" - }, - "macAddress" : "00-0D-3A-1B-C7-21", - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false, - "networkSecurityGroup" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" - }, - "primary" : true, - "virtualMachine" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" - } - }, - "type" : "Microsoft.Network/networkInterfaces" - }, - { - "name" : "test-nic2", - "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", - "location" : "eastus", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - ] - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreate.json index 4efc0e2937cf..b8cbe1a64861 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreate.json @@ -1,231 +1,231 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "parameters": {} - }, - "responses" : { - "200" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - }, - "201" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreateWithRule.json index a81352e15d6e..248cfbee6fb8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreateWithRule.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -1,281 +1,281 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "parameters": { - "properties": { - "securityRules": [ - { - "name": "rule1", - "properties": { - "protocol": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "destinationPortRange": "80", - "sourcePortRange": "*", - "priority": 130, - "direction": "Inbound" - } - } - ] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ - { - "name": "rule1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "80", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 130, - "direction": "Inbound" - } - } - ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - }, - "201" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ - { - "name": "rule1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "80", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 130, - "direction": "Inbound" - } - } - ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupDelete.json index ccfe883da07a..734dbdeb2217 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupGet.json index 609d383e9a24..4050720614b9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupGet.json @@ -1,136 +1,136 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg" - }, - "responses" : { - "200" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ - { - "name": "rule1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "80", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 130, - "direction": "Inbound" - } - } - ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupList.json index bbd4e794b8a8..86b3750d0e5f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupList.json @@ -1,231 +1,231 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "nsg1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - }, - { - "name": "nsg3", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupListAll.json index 7e4726ac844d..398b94f72320 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupListAll.json @@ -1,230 +1,230 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "nsg1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - }, - { - "name": "nsg3", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "securityRules": [], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleCreate.json index 383d9112025d..96a328e6a4fa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleCreate.json @@ -1,57 +1,57 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "securityRuleName": "rule1", - "securityRuleParameters": { - "properties": { - "protocol": "*", - "sourceAddressPrefix": "10.0.0.0/8", - "destinationAddressPrefix": "11.0.0.0/8", - "access": "Deny", - "destinationPortRange": "8080", - "sourcePortRange": "*", - "priority": 100, - "direction": "Outbound" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "rule1", - "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "8080", - "sourceAddressPrefix": "10.0.0.0/8", - "destinationAddressPrefix": "11.0.0.0/8", - "access": "Deny", - "priority": 100, - "direction": "Outbound" - } - } - }, - "201" : { - "body" : { - "name": "rule1", - "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "8080", - "sourceAddressPrefix": "10.0.0.0/8", - "destinationAddressPrefix": "11.0.0.0/8", - "access": "Deny", - "priority": 100, - "direction": "Outbound" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleDelete.json index 08ea3f884603..a904cc127fe8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleDelete.json @@ -1,14 +1,14 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "securityRuleName": "rule1" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleGet.json index dac2a4dce0df..05a8c7345848 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleGet.json @@ -1,28 +1,28 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "securityRuleName": "rule1" - }, - "responses" : { - "200" : { - "body" : { - "name": "rule1", - "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "80", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 130, - "direction": "Inbound" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleList.json index d108ef2428b7..c39a24a53f0b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkSecurityGroupRuleList.json @@ -1,31 +1,31 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "rule1", - "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", - "properties": { - "provisioningState": "Succeeded", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "80", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 130, - "direction": "Inbound" - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateCustomizedValues.json index ec77ade17065..46252b7eed29 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateCustomizedValues.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -1,54 +1,54 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip", - "zones": [ "1" ], - "parameters": { - "properties": { - "publicIPAllocationMethod": "Static", - "idleTimeoutInMinutes": 10, - "publicIPAddressVersion": "IPv4" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "zones": [ "1" ], - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Static", - "idleTimeoutInMinutes" : 10, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - }, - "201" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "zones": [ "1" ], - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Static", - "idleTimeoutInMinutes" : 10, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ "1" ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDefaults.json index 2c56f46f78a4..f92adc9f10b0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDefaults.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDefaults.json @@ -1,45 +1,45 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip", - "parameters": {} - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - }, - "201" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDns.json index 65aba235b107..17ed0681374a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDns.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressCreateDns.json @@ -1,59 +1,59 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip", - "parameters": { - "properties": { - "dnsSettings": { - "domainNameLabel": "dnslbl" - } - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "dnsSettings" : { - "domainNameLabel" : "dnslbl", - "fqdn" : "dnslbl.westus.cloudapp.azure.com" - }, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - }, - "201" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "dnsSettings" : { - "domainNameLabel" : "dnslbl", - "fqdn" : "dnslbl.westus.cloudapp.azure.com" - }, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressDelete.json index 198760b4a671..2acdd5f6817d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressGet.json index 2d9a0c5d6c80..9fcccf845f1e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressGet.json @@ -1,27 +1,27 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "testDNS-ip" - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressList.json index 647957d8378e..87c1e9c20794 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressList.json @@ -1,50 +1,50 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - }, - { - "name" : "ip03", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "ipAddress" : "40.85.154.247", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "dnsSettings" : { - "domainNameLabel" : "testlbl", - "fqdn" : "testlbl.westus.cloudapp.azure.com" - }, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - ] - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip03", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressListAll.json index 59ce26d48c9f..414c160a5497 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/PublicIpAddressListAll.json @@ -1,49 +1,49 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value" : [ - { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - }, - { - "name" : "ip01", - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "ipAddress" : "40.85.154.247", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Dynamic", - "idleTimeoutInMinutes" : 4, - "dnsSettings" : { - "domainNameLabel" : "testlbl", - "fqdn" : "testlbl.westus.cloudapp.azure.com" - }, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" - } - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - ] - } - } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip01", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreate.json index 7dcd711e53a7..28e19bdbf94d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreate.json @@ -1,35 +1,35 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "parameters": {} - }, - "responses" : { - "200" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - }, - "201" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreateWithRoute.json index 8aa4e35746a7..aa420e8efa12 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreateWithRoute.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableCreateWithRoute.json @@ -1,67 +1,67 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "parameters": { - "properties": { - "routes": [ - { - "name": "route1", - "properties": { - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - } - }, - "201" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "properties": { + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableDelete.json index 24318e243759..57248eb1dd11 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableGet.json index 92c058069282..881d6352a66e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableGet.json @@ -1,32 +1,32 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt" - }, - "responses" : { - "200" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableList.json index 476e4f9657c8..d80ffb3046c0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableList.json @@ -1,45 +1,45 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - }, - { - "name": "testrt2", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableListAll.json index 7bc65ef2855c..69ab346d079f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableListAll.json @@ -1,44 +1,44 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - }, - { - "name": "testrt3", - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteCreate.json index 6a4b53a996cb..a408e800697c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteCreate.json @@ -1,39 +1,39 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "routeName": "route1", - "routeParameters": { - "properties": { - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - }, - "201" : { - "body" : { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteDelete.json index 1d7f348136a7..70f04f612c27 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteDelete.json @@ -1,14 +1,14 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "routeName": "route1" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteGet.json index 2098ec0d9ada..f081e9fde049 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteGet.json @@ -1,22 +1,22 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "routeName": "route1" - }, - "responses" : { - "200" : { - "body" : { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "Internet" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteList.json index c011c78d1308..3ea5d03e533e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/RouteTableRouteList.json @@ -1,34 +1,34 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "route1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.3.0/24", - "nextHopType": "Internet" - } - }, - { - "name": "route2", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.2.0/24", - "nextHopType": "VirtualNetworkGateway" - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreate.json index adb579555c8e..ca5df74388d1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreate.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "subnetParameters": { - "properties": { - "addressPrefix": "10.0.0.0/16" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreateServiceEndpoint.json index 474465e60260..4f7a96f06783 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreateServiceEndpoint.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetCreateServiceEndpoint.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "subnetParameters": { - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [ - { "service": "Microsoft.Storage" } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [{ - "service": "Microsoft.Storage", - "locations": [ - "eastus2(stage)", - "usnorth(stage)" - ], - "provisioningState": "Succeeded" - }], - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [{ - "service": "Microsoft.Storage", - "locations": [ - "eastus2(stage)", - "usnorth(stage)" - ], - "provisioningState": "Succeeded" - }], - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { "service": "Microsoft.Storage" } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetDelete.json index c89144d7e4e6..497ce0515756 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { }, - "202": { }, - "204": { } - } +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetGet.json index 3cbaec60b184..31d4efd768ae 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetGet.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetList.json index 7d29c5b5f02b..68fa32e8271e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/SubnetList.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", - "name": "subnet2", - "properties": { - "addressPrefix": "10.0.0.0/16", - "provisioningState": "Succeeded" - } - } - ] - } - } - } +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/UsageList.json index 4fe4f184bd4c..8472da1b4c2a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/UsageList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/UsageList.json @@ -1,114 +1,114 @@ -{ - "parameters": { - "location": "westus", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "unit": "Count", - "currentValue": 47, - "limit": 100, - "name": { - "value": "VirtualNetworks", - "localizedValue": "Virtual Networks" - } - }, - { - "unit": "Count", - "currentValue": 2, - "limit": 20, - "name": { - "value": "StaticPublicIPAddresses", - "localizedValue": "Static Public IP Addresses" - } - }, - { - "unit": "Count", - "currentValue": 19, - "limit": 100, - "name": { - "value": "NetworkSecurityGroups", - "localizedValue": "Network Security Groups" - } - }, - { - "unit": "Count", - "currentValue": 43, - "limit": 60, - "name": { - "value": "PublicIPAddresses", - "localizedValue": "Public IP Addresses" - } - }, - { - "unit": "Count", - "currentValue": 33, - "limit": 5000, - "name": { - "value": "NetworkInterfaces", - "localizedValue": "Network Interfaces" - } - }, - { - "unit": "Count", - "currentValue": 11, - "limit": 100, - "name": { - "value": "LoadBalancers", - "localizedValue": "Load Balancers" - } - }, - { - "unit": "Count", - "currentValue": 0, - "limit": 50, - "name": { - "value": "ApplicationGateways", - "localizedValue": "Application Gateways" - } - }, - { - "unit": "Count", - "currentValue": 3, - "limit": 100, - "name": { - "value": "RouteTables", - "localizedValue": "Route Tables" - } - }, - { - "unit": "Count", - "currentValue": 0, - "limit": 1000, - "name": { - "value": "RouteFilters", - "localizedValue": "Route Filters" - } - }, - { - "unit": "Count", - "currentValue": 0, - "limit": 1, - "name": { - "value": "NetworkWatchers", - "localizedValue": "Network Watchers" - } - }, - { - "unit": "Count", - "currentValue": 0, - "limit": 10, - "name": { - "value": "PacketCaptures", - "localizedValue": "Packet Captures" - } - } - ] - } - } - } +{ + "parameters": { + "location": "westus", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 47, + "limit": 100, + "name": { + "value": "VirtualNetworks", + "localizedValue": "Virtual Networks" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": 20, + "name": { + "value": "StaticPublicIPAddresses", + "localizedValue": "Static Public IP Addresses" + } + }, + { + "unit": "Count", + "currentValue": 19, + "limit": 100, + "name": { + "value": "NetworkSecurityGroups", + "localizedValue": "Network Security Groups" + } + }, + { + "unit": "Count", + "currentValue": 43, + "limit": 60, + "name": { + "value": "PublicIPAddresses", + "localizedValue": "Public IP Addresses" + } + }, + { + "unit": "Count", + "currentValue": 33, + "limit": 5000, + "name": { + "value": "NetworkInterfaces", + "localizedValue": "Network Interfaces" + } + }, + { + "unit": "Count", + "currentValue": 11, + "limit": 100, + "name": { + "value": "LoadBalancers", + "localizedValue": "Load Balancers" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": 50, + "name": { + "value": "ApplicationGateways", + "localizedValue": "Application Gateways" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": 100, + "name": { + "value": "RouteTables", + "localizedValue": "Route Tables" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": 1000, + "name": { + "value": "RouteFilters", + "localizedValue": "Route Filters" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": 1, + "name": { + "value": "NetworkWatchers", + "localizedValue": "Network Watchers" + } + }, + { + "unit": "Count", + "currentValue": 0, + "limit": 10, + "name": { + "value": "PacketCaptures", + "localizedValue": "Packet Captures" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCheckIPAddressAvailability.json index 53843012a33a..29cb05c909a1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCheckIPAddressAvailability.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -1,23 +1,23 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "IPAddress": "10.0.1.4" - }, - "responses" : { - "200" : { - "body" : { - "available": false, - "availableIPAddresses": [ - "10.0.1.5", - "10.0.1.6", - "10.0.1.7", - "10.0.1.8", - "10.0.1.9" - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "IPAddress": "10.0.1.4" + }, + "responses" : { + "200" : { + "body" : { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreate.json index 2e99f253077a..409b136cb2fb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreate.json @@ -1,56 +1,56 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "location": "westus", - "parameters": { - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - } - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets" : [], - "virtualNetworkPeerings" : [] - } - } - }, - "201" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets" : [], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreateSubnet.json index 587126eda309..62841d2736b9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreateSubnet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkCreateSubnet.json @@ -1,81 +1,81 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "parameters": { - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24" - } - } - ] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - }, - "201" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded" - } - } - ], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkDelete.json index 074886ec4980..08c1d7011164 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkDelete.json @@ -1,13 +1,13 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "virtualNetworkName": "test-vnet" - }, - "responses" : { - "200" : { }, - "202" : { }, - "204" : { } - } +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkGet.json index daa12d14e7e1..18f0825db8b1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkGet.json @@ -1,41 +1,41 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet" - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets" : [{ - "name" : "subnet1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", - "properties" : { - "provisioningState" : "Succeeded", - - "addressPrefix" : "10.0.1.0/24", - "ipConfigurations" : [{ - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" - } - ] - } - } - ], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [{ + "name" : "subnet1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties" : { + "provisioningState" : "Succeeded", + + "addressPrefix" : "10.0.1.0/24", + "ipConfigurations" : [{ + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkList.json index 88c225816cd4..7ab4eba709f5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkList.json @@ -1,64 +1,64 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", - "name": "vnet1", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/8" - ] - }, - "dhcpOptions": { - "dnsServers": [] - }, - "subnets": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded" - } - } - ], - "virtualNetworkPeerings": [], - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", - "name": "vnet2", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "8.8.8.8" - ] - }, - "subnets": [], - "virtualNetworkPeerings": [], - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkListAll.json index baff846f6090..ea2f96058361 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkListAll.json @@ -1,63 +1,63 @@ -{ - "parameters" : { - "api-version" : "2017-06-01", - "subscriptionId" : "subid" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", - "name": "vnet1", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/8" - ] - }, - "dhcpOptions": { - "dnsServers": [] - }, - "subnets": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", - "name": "test-1", - "properties": { - "addressPrefix": "10.0.0.0/24", - "provisioningState": "Succeeded" - } - } - ], - "virtualNetworkPeerings": [], - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", - "name": "vnet2", - "type": "Microsoft.Network/virtualNetworks", - "location": "westus", - "properties": { - "addressSpace": { - "addressPrefixes": [ - "10.0.0.0/16" - ] - }, - "dhcpOptions": { - "dnsServers": [ - "8.8.8.8" - ] - }, - "subnets": [], - "virtualNetworkPeerings": [], - "provisioningState": "Succeeded" - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-06-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringCreate.json index 9495e21ec70c..4f1e4ccd20e9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringCreate.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "virtualNetworkPeeringName": "peer", - "virtualNetworkName": "vnet1", - "resourceGroupName": "peerTest", - "api-version": "2017-06-01", - "subscriptionId": "subid", - "VirtualNetworkPeeringParameters": { - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", - "name": "peer", - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" - }, - "peeringState": "Initiated", - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", - "name": "peer", - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" - }, - "peeringState": "Initiated", - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2017-06-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringDelete.json index d47526860aba..d838278c21e4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringDelete.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringDelete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "virtualNetworkPeeringName": "peer", - "virtualNetworkName": "vnet1", - "resourceGroupName": "peerTest", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { }, - "202": { }, - "204": { } - } +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringGet.json index 467e162824ec..fb141458c6f5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringGet.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "virtualNetworkPeeringName": "peer", - "virtualNetworkName": "vnet1", - "resourceGroupName": "peerTest", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", - "name": "peer", - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" - }, - "peeringState": "Initiated", - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringList.json index 1460b09a8ff3..f1ed95ee3ff2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VirtualNetworkPeeringList.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "virtualNetworkName": "vnet1", - "resourceGroupName": "peerTest", - "api-version": "2017-06-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", - "name": "peer", - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": true, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" - }, - "peeringState": "Initiated", - "provisioningState": "Succeeded" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", - "name": "peer", - "properties": { - "allowVirtualNetworkAccess": true, - "allowForwardedTraffic": false, - "allowGatewayTransit": false, - "useRemoteGateways": false, - "remoteVirtualNetwork": { - "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" - }, - "peeringState": "Initiated", - "provisioningState": "Succeeded" - } - } - ] - } - } - } +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2017-06-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceGet.json index 94a317d312b6..6a309c899c6b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceGet.json @@ -1,65 +1,65 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkInterfaceName" : "nic1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "1" - }, - "responses" : { - "200" : { - "body" : { - "name" : "nic1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [ - { - "name" : "ip1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "10.0.0.5", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4", - "loadBalancerBackendAddressPools" : [ - { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules" : [ - { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" - } - ] - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [], - "internalDomainNameSuffix" : "dns.cdmx.internal.cloudapp.net" - }, - "macAddress" : "00-00-00-00-00-00", - "enableAcceleratedNetworking" : false, - "enableIPForwarding" : false, - "networkSecurityGroup" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" - }, - "primary" : true, - "virtualMachine" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" - } - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkInterfaceName" : "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "nic1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [ + { + "name" : "ip1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "10.0.0.5", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4", + "loadBalancerBackendAddressPools" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "dns.cdmx.internal.cloudapp.net" + }, + "macAddress" : "00-00-00-00-00-00", + "enableAcceleratedNetworking" : false, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceList.json index d9351a7573c1..01cc5ea64615 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssNetworkInterfaceList.json @@ -1,118 +1,118 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "nic1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", - "properties": { - "provisioningState": "Succeeded", - "ipConfigurations": [ - { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.4", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" - }, - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" - } - ] - } - } - ], - "dnsSettings": { - "dnsServers": [], - "appliedDnsServers": [], - "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" - }, - "macAddress": "00-00-00-00-00-00", - "enableAcceleratedNetworking": false, - "enableIPForwarding": false, - "networkSecurityGroup": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" - }, - "primary": true, - "virtualMachine": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" - } - } - }, - { - "name": "nic1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", - "properties": { - "provisioningState": "Succeeded", - "ipConfigurations": [ - { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.5", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" - }, - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" - } - ] - } - } - ], - "dnsSettings": { - "dnsServers": [], - "appliedDnsServers": [], - "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" - }, - "macAddress": "00-00-00-00-00-00", - "enableAcceleratedNetworking": false, - "enableIPForwarding": false, - "networkSecurityGroup": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" - }, - "primary": true, - "virtualMachine": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" - } - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssVmNetworkInterfaceList.json index 24a96ace17d2..36e0b86265c0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssVmNetworkInterfaceList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/VmssVmNetworkInterfaceList.json @@ -1,68 +1,68 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "nic1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", - "properties": { - "provisioningState": "Succeeded", - "ipConfigurations": [ - { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.5", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" - }, - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" - } - ] - } - } - ], - "dnsSettings": { - "dnsServers": [], - "appliedDnsServers": [], - "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" - }, - "macAddress": "00-00-00-00-00-00", - "enableAcceleratedNetworking": false, - "enableIPForwarding": false, - "networkSecurityGroup": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" - }, - "primary": true, - "virtualMachine": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" - } - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/endpointService.json index d250c4f9450b..7bc037f2fb2d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/endpointService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/endpointService.json @@ -1,127 +1,127 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2017-08-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { - "get": { - "operationId": "AvailableEndpointServices_List", - "description": "List what values of endpoint services are available for use.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location to check available endpoint services." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. Returns list of available endpoint services.", - "schema": { - "$ref": "#/definitions/EndpointServicesListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } - } - } - } - }, - "definitions": { - "EndpointServicesListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EndpointServiceResult" - }, - "description": "List of available endpoint services in a region." - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results." - } - }, - "description": "Response for the ListAvailableEndpointServices API service call." - }, - "EndpointServiceResult": { - "properties": { - "name": { - "type": "string", - "description": "Name of the endpoint service.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Type of the endpoint service.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/SubResource" - } - ], - "description": "Endpoint service." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/EndpointServicesList.json index 041466922ddf..6dca61f7d577 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/EndpointServicesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/EndpointServicesList.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "location": "westus", - "api-version": "2017-08-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.Storage", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - }, - { - "name": "Microsoft.Sql", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - }, - { - "name": "Microsoft.AzureActiveDirectory", - "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", - "type": "Microsoft.Network/virtualNetworkEndpointServices" - } - ] - } - } - } +{ + "parameters": { + "location": "westus", + "api-version": "2017-08-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/LoadBalancerCreateWithZones.json index 8367e0dd4edf..1a11df328fde 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/LoadBalancerCreateWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/LoadBalancerCreateWithZones.json @@ -1,335 +1,335 @@ -{ - "parameters" : { - "api-version" : "2017-08-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "properties": { - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "properties": { - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - }, - "zones": [ "1" ] - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "properties": { - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "properties": { - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "inboundNatPools": [], - "outboundNatRules": [] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - }, - "201" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-08-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + }, + "zones": [ "1" ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/SubnetCreateServiceEndpoint.json index a7d81ff09e51..4b3550d4d969 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/SubnetCreateServiceEndpoint.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/SubnetCreateServiceEndpoint.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "subnetName": "subnet1", - "virtualNetworkName": "vnetname", - "resourceGroupName": "subnet-test", - "api-version": "2017-08-01", - "subscriptionId": "subid", - "subnetParameters": { - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [ - { "service": "Microsoft.Storage" } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [{ - "service": "Microsoft.Storage", - "locations": [ - "eastus2(stage)", - "usnorth(stage)" - ], - "provisioningState": "Succeeded" - }], - "provisioningState": "Succeeded" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", - "name": "subnet1", - "properties": { - "addressPrefix": "10.0.0.0/16", - "serviceEndpoints": [{ - "service": "Microsoft.Storage", - "locations": [ - "eastus2(stage)", - "usnorth(stage)" - ], - "provisioningState": "Succeeded" - }], - "provisioningState": "Succeeded" - } - } - } - } +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2017-08-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { "service": "Microsoft.Storage" } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ApplicationGatewayUpdateTags.json index 846037fd97d0..c5957cd03667 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ApplicationGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ApplicationGatewayUpdateTags.json @@ -1,148 +1,148 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "applicationGatewayName" : "AppGw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "AppGw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", - "type": "Microsoft.Network/applicationGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "sku": { - "name": "Standard_Small", - "tier": "Standard", - "capacity": 2 - }, - "operationalState": "Running", - "gatewayIPConfigurations": [ - { - "name": "GatewayIp01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", - "properties": { - "provisioningState": "Succeeded", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" - } - } - } - ], - "sslCertificates": [], - "authenticationCertificates": [], - "frontendIPConfigurations": [ - { - "name": "FrontEndConfig01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", - "properties": { - "provisioningState": "Succeeded", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" - } - } - } - ], - "frontendPorts": [ - { - "name": "FrontEndPort01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", - "properties": { - "provisioningState": "Succeeded", - "port": 80 - } - } - ], - "backendAddressPools": [ - { - "name": "Pool01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", - "properties": { - "provisioningState": "Succeeded", - "backendAddresses": [ - { - "ipAddress": "10.10.10.1" - }, - { - "ipAddress": "10.10.10.2" - }, - { - "ipAddress": "10.10.10.3" - } - ] - } - } - ], - "backendHttpSettingsCollection": [ - { - "name": "PoolSetting01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", - "properties": { - "provisioningState": "Succeeded", - "port": 80, - "protocol": "Http", - "cookieBasedAffinity": "Disabled", - "pickHostNameFromBackendAddress": false, - "requestTimeout": 30 - } - } - ], - "httpListeners": [ - { - "name": "listener1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" - }, - "frontendPort": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" - }, - "protocol": "Http", - "requireServerNameIndication": false - } - } - ], - "urlPathMaps": [], - "requestRoutingRules": [ - { - "name": "Rule01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", - "properties": { - "provisioningState": "Succeeded", - "ruleType": "Basic", - "httpListener": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" - }, - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" - }, - "backendHttpSettings": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" - } - } - } - ], - "probes": [], - "redirectConfigurations": [] - } - } - } - } +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationGatewayName" : "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ExpressRouteCircuitUpdateTags.json index b9c39e113ce4..e436d0674785 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ExpressRouteCircuitUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/ExpressRouteCircuitUpdateTags.json @@ -1,48 +1,48 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "ertest", - "circuitName" : "er1", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "er1", - "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", - "type": "Microsoft.Network/expressRouteCircuits", - "location": "brazilsouth", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Failed", - "peerings": [], - "authorizations": [], - "serviceProviderProperties": { - "serviceProviderName": "Equinix", - "peeringLocation": "Silicon Valley", - "bandwidthInMbps": 1000 - }, - "circuitProvisioningState": "Enabled", - "allowClassicOperations": false, - "gatewayManagerEtag": "", - "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", - "serviceProviderProvisioningState": "NotProvisioned" - }, - "sku": { - "name": "Standard_MeteredData", - "tier": "Standard", - "family": "MeteredData" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "ertest", + "circuitName" : "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerCreateWithZones.json index 2654ecb4f8e6..86c6fbc55e33 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerCreateWithZones.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerCreateWithZones.json @@ -1,335 +1,335 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "properties": { - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "properties": { - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - }, - "zones": [ "1" ] - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "properties": { - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - } - } - } - ], - "probes": [ - { - "name": "probe-lb", - "properties": { - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "properties": { - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "inboundNatPools": [], - "outboundNatRules": [] - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - }, - "201" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "sku": { - "name": "Basic" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "zones": [ "1" ], - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + }, + "zones": [ "1" ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundNatRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerUpdateTags.json index a02c80ed77b1..caea75dbff76 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LoadBalancerUpdateTags.json @@ -1,132 +1,132 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LocalNetworkGatewayUpdateTags.json index eae1a0089055..d39054ca15b7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LocalNetworkGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/LocalNetworkGatewayUpdateTags.json @@ -1,38 +1,38 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "localNetworkGatewayName": "lgw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lgw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", - "type": "Microsoft.Network/localNetworkGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "localNetworkAddressSpace": { - "addressPrefixes": [ - "12.0.0.0/8" - ] - }, - "gatewayIpAddress": "12.0.0.1" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkInterfaceUpdateTags.json index e46639bd5783..7e9b4880a753 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkInterfaceUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkInterfaceUpdateTags.json @@ -1,55 +1,55 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "test-nic", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkSecurityGroupUpdateTags.json index ae18ec0eac00..b38fc48a190f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkSecurityGroupUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkSecurityGroupUpdateTags.json @@ -1,130 +1,130 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherUpdateTags.json index dec5738846c2..33039a9a3a50 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherUpdateTags.json @@ -1,32 +1,32 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkWatcherName" : "nw1", - "parameters" : { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "nw1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", - "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", - "type" : "Microsoft.Network/networkWatchers", - "location" : "eastus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/OperationList.json index 8698a6694c80..0797e392a4d8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/OperationList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/OperationList.json @@ -1,137 +1,137 @@ -{ - "parameters": { - "location": "westus", - "api-version": "2017-09-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.Network/localnetworkgateways/read", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Get LocalNetworkGateway", - "description": "Gets LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/localnetworkgateways/write", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Create or update LocalNetworkGateway", - "description": "Creates or updates an existing LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/localnetworkgateways/delete", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Delete LocalNetworkGateway", - "description": "Deletes LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", - "display": { - "provider": "Microsoft Network", - "resource": "Network Interface metric definition", - "operation": "Read Network Interface metric definitions", - "description": "Gets available metrics for the Network Interface" - }, - "origin": "system", - "properties": { - "serviceSpecification": { - "metricSpecifications": [ - { - "name": "BytesSentRate", - "displayName": "Bytes Sent", - "displayDescription": "Number of bytes the Network Interface sent", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "00:01:00", - "retention": "00:00:00", - "blobDuration": "01:00:00" - }, - { - "timeGrain": "01:00:00", - "retention": "00:00:00", - "blobDuration": "1.00:00:00" - } - ], - "enableRegionalMdmAccount": false, - "metricFilterPattern": "^__Ready__$", - "fillGapWithZero": false, - "dimensions": [], - "isInternal": false - }, - { - "name": "BytesReceivedRate", - "displayName": "Bytes Received", - "displayDescription": "Number of bytes the Network Interface received", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "00:01:00", - "retention": "00:00:00", - "blobDuration": "01:00:00" - }, - { - "timeGrain": "01:00:00", - "retention": "00:00:00", - "blobDuration": "1.00:00:00" - } - ], - "enableRegionalMdmAccount": false, - "metricFilterPattern": "^__Ready__$", - "fillGapWithZero": false, - "dimensions": [], - "isInternal": false - } - ] - } - } - }, - { - "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", - "display": { - "provider": "Microsoft Network", - "resource": "Network Security Groups Log Definitions", - "operation": "Get Network Security Group Event Log Definitions", - "description": "Gets the events for network security group" - }, - "origin": "system", - "properties": { - "serviceSpecification": { - "logSpecifications": [ - { - "name": "NetworkSecurityGroupEvent", - "displayName": "Network Security Group Event", - "blobDuration": "PT1H" - }, - { - "name": "NetworkSecurityGroupRuleCounter", - "displayName": "Network Security Group Rule Counter", - "blobDuration": "PT1H" - }, - { - "name": "NetworkSecurityGroupFlowEvent", - "displayName": "Network Security Group Rule Flow Event", - "blobDuration": "PT1H" - } - ] - } - } - } - ] - } - } - } +{ + "parameters": { + "location": "westus", + "api-version": "2017-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/PublicIpAddressUpdateTags.json index 7c3c60066f72..3d11597c584d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/PublicIpAddressUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/PublicIpAddressUpdateTags.json @@ -1,37 +1,37 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Static", - "idleTimeoutInMinutes" : 10, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/RouteTableUpdateTags.json index f94099dd8870..9ee39ebf57c5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/RouteTableUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/RouteTableUpdateTags.json @@ -1,32 +1,32 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/UsageListSpacedLocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/UsageListSpacedLocation.json index 85cf38b53b2b..fc4590090144 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/UsageListSpacedLocation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/UsageListSpacedLocation.json @@ -1,265 +1,265 @@ -{ - "parameters": { - "location": "west us", - "api-version": "2017-09-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "currentValue": 8.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", - "limit": 50.0, - "name": { - "localizedValue": "Virtual Networks", - "value": "VirtualNetworks" - }, - "unit": "Count" - }, - { - "currentValue": 3.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", - "limit": 20.0, - "name": { - "localizedValue": "Static Public IP Addresses", - "value": "StaticPublicIPAddresses" - }, - "unit": "Count" - }, - { - "currentValue": 1.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", - "limit": 100.0, - "name": { - "localizedValue": "Network Security Groups", - "value": "NetworkSecurityGroups" - }, - "unit": "Count" - }, - { - "currentValue": 8.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", - "limit": 60.0, - "name": { - "localizedValue": "Public IP Addresses", - "value": "PublicIPAddresses" - }, - "unit": "Count" - }, - { - "currentValue": 2.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", - "limit": 350.0, - "name": { - "localizedValue": "Network Interfaces", - "value": "NetworkInterfaces" - }, - "unit": "Count" - }, - { - "currentValue": 2.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", - "limit": 100.0, - "name": { - "localizedValue": "Load Balancers", - "value": "LoadBalancers" - }, - "unit": "Count" - }, - { - "currentValue": 1.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", - "limit": 50.0, - "name": { - "localizedValue": "Application Gateways", - "value": "ApplicationGateways" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", - "limit": 100.0, - "name": { - "localizedValue": "Route Tables", - "value": "RouteTables" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", - "limit": 1000.0, - "name": { - "localizedValue": "Route Filters", - "value": "RouteFilters" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", - "limit": 1.0, - "name": { - "localizedValue": "Network Watchers", - "value": "NetworkWatchers" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", - "limit": 10.0, - "name": { - "localizedValue": "Packet Captures", - "value": "PacketCaptures" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", - "limit": 9.0, - "name": { - "localizedValue": "DNS servers per Virtual Network", - "value": "DnsServersPerVirtualNetwork" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", - "limit": 1000.0, - "name": { - "localizedValue": "Subnets per Virtual Network", - "value": "SubnetsPerVirtualNetwork" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", - "limit": 4096.0, - "name": { - "localizedValue": "IP Configurations per Virtual Network", - "value": "IPConfigurationsPerVirtualNetwork" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", - "limit": 10.0, - "name": { - "localizedValue": "Peerings per Virtual Network", - "value": "PeeringsPerVirtualNetwork" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", - "limit": 200.0, - "name": { - "localizedValue": "Security rules per Network Security Group", - "value": "SecurityRulesPerNetworkSecurityGroup" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", - "limit": 2000.0, - "name": { - "localizedValue": "Security rules addresses or ports per Network Security Group", - "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", - "limit": 150.0, - "name": { - "localizedValue": "Inbound Rules per Load Balancer", - "value": "InboundRulesPerLoadBalancer" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", - "limit": 10.0, - "name": { - "localizedValue": "Frontend IP Configurations per Load Balancer", - "value": "FrontendIPConfigurationPerLoadBalancer" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/OutboundNatRulesPerLoadBalancer", - "limit": 5.0, - "name": { - "localizedValue": "Outbound NAT Rules per Load Balancer", - "value": "OutboundNatRulesPerLoadBalancer" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", - "limit": 100.0, - "name": { - "localizedValue": "Routes per Route Table", - "value": "RoutesPerRouteTable" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", - "limit": 256.0, - "name": { - "localizedValue": "Secondary IP Configurations per Network Interface", - "value": "SecondaryIPConfigurationsPerNetworkInterface" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", - "limit": 500.0, - "name": { - "localizedValue": "Inbound rules per Network Interface", - "value": "InboundRulesPerNetworkInterface" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", - "limit": 1.0, - "name": { - "localizedValue": "Route filter rules per Route Filter", - "value": "RouteFilterRulesPerRouteFilter" - }, - "unit": "Count" - }, - { - "currentValue": 0.0, - "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", - "limit": 1.0, - "name": { - "localizedValue": "Route filters per Express route BGP Peering", - "value": "RouteFiltersPerExpressRouteBgpPeering" - }, - "unit": "Count" - } - ] - } - } - } +{ + "parameters": { + "location": "west us", + "api-version": "2017-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/OutboundNatRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound NAT Rules per Load Balancer", + "value": "OutboundNatRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json index ed80205cda1e..ce3e3dc369b7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -1,47 +1,47 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkGatewayConnectionName": "test", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "test", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", - "type": "Microsoft.Network/connections", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "virtualNetworkGateway1": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw" - }, - "localNetworkGateway2": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw" - }, - "connectionType": "IPsec", - "routingWeight": 0, - "sharedKey": "temp1234", - "enableBgp": false, - "usePolicyBasedTrafficSelectors": false, - "ipsecPolicies": [], - "connectionStatus": "Unknown", - "ingressBytesTransferred": 0, - "egressBytesTransferred": 0 - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw" + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw" + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayUpdateTags.json index a8ba58117033..f012ae85d16c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -1,62 +1,62 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkGatewayName" : "vpngw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "vpngw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", - "type": "Microsoft.Network/virtualNetworkGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "ipConfigurations": [ - { - "name": "default", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", - "properties": { - "provisioningState": "Succeeded", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" - }, - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" - } - } - } - ], - "sku": { - "name": "VpnGw1", - "tier": "VpnGw1", - "capacity": 2 - }, - "gatewayType": "Vpn", - "vpnType": "RouteBased", - "enableBgp": false, - "activeActive": false, - "bgpSettings": { - "asn": 65515, - "bgpPeeringAddress": "10.0.0.254", - "peerWeight": 0 - } - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkUpdateTags.json index f5aed0db8790..072df547c2ca 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VirtualNetworkUpdateTags.json @@ -1,39 +1,39 @@ -{ - "parameters" : { - "api-version" : "2017-09-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "location": "westus", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets" : [], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-09-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigGet.json index 7eda8f4cdf2b..50253777dc63 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -1,39 +1,39 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "2", - "networkInterfaceName": "nic1", - "ipConfigurationName": "ip1" - }, - "responses" : { - "200" : { - "body" : { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.6", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses" : { + "200" : { + "body" : { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigList.json index 4ad2afcbe0fa..fe4db041f128 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -1,42 +1,42 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "2", - "networkInterfaceName": "nic1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.6", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/operation.json index 4386d73f8cdd..11b1605f1d5d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/operation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/operation.json @@ -1,279 +1,279 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2017-09-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Network/operations": { - "get": { - "operationId": "Operations_List", - "description": "Lists all of the available Network Rest API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Network operations supported by the Network resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "Network REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft Network.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Type of the operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of the operation.", - "type": "string" - } - } - }, - "origin": { - "description": "Origin of the operation.", - "type": "string" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationPropertiesFormat", - "description": "Operation properties format." - } - } - }, - "OperationPropertiesFormat": { - "description": "Description of operation properties format.", - "properties": { - "serviceSpecification": { - "description": "Specification of the service.", - "properties": { - "metricSpecifications": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - }, - "description": "Operation service specification." - }, - "logSpecifications": { - "type": "array", - "items": { - "$ref": "#/definitions/LogSpecification" - }, - "description": "Operation log specification." - } - } - } - } - }, - "LogSpecification": { - "description": "Description of logging specification.", - "properties": { - "name": { - "type": "string", - "description": "The name of the specification." - }, - "displayName": { - "type": "string", - "description": "The display name of the specification." - }, - "blobDuration": { - "type": "string", - "description": "Duration of the blob." - } - } - }, - "MetricSpecification": { - "description": "Description of metrics specification.", - "properties": { - "name": { - "type": "string", - "description": "The name of the metric." - }, - "displayName": { - "type": "string", - "description": "The display name of the metric." - }, - "displayDescription": { - "type": "string", - "description": "The description of the metric." - }, - "unit": { - "type": "string", - "description": "Units the metric to be displayed in." - }, - "aggregationType": { - "type": "string", - "description": "The aggregation type." - }, - "availabilities": { - "type": "array", - "items": { - "$ref": "#/definitions/Availability" - }, - "description": "List of availability." - }, - "enableRegionalMdmAccount": { - "type": "boolean", - "description": "Whether regional MDM account enabled." - }, - "fillGapWithZero": { - "type": "boolean", - "description": "Whether gaps would be filled with zeros." - }, - "metricFilterPattern": { - "type": "string", - "description": "Pattern for the filter of the metric." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/Dimension" - }, - "description": "List of dimensions." - }, - "isInternal": { - "type": "boolean", - "description": "Whether the metric is internal." - }, - "sourceMdmAccount": { - "type": "string", - "description": "The source MDM account." - }, - "sourceMdmNamespace": { - "type": "string", - "description": "The source MDM namespace." - }, - "resourceIdDimensionNameOverride": { - "type": "string", - "description": "The resource Id dimension name override." - } - } - }, - "Dimension": { - "description": "Dimension of the metric.", - "properties": { - "name": { - "type": "string", - "description": "The name of the dimension." - }, - "displayName": { - "type": "string", - "description": "The display name of the dimension." - }, - "internalName": { - "type": "string", - "description": "The internal name of the dimension." - } - } - }, - "Availability": { - "description": "Availability of the metric.", - "properties": { - "timeGrain": { - "type": "string", - "description": "The time grain of the availability." - }, - "retention": { - "type": "string", - "description": "The retention of the availability." - }, - "blobDuration": { - "type": "string", - "description": "Duration of the availability blob." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ApplicationGatewayUpdateTags.json index 260541537c40..857c00e49e46 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ApplicationGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ApplicationGatewayUpdateTags.json @@ -1,148 +1,148 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "applicationGatewayName" : "AppGw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "AppGw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", - "type": "Microsoft.Network/applicationGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "sku": { - "name": "Standard_Small", - "tier": "Standard", - "capacity": 2 - }, - "operationalState": "Running", - "gatewayIPConfigurations": [ - { - "name": "GatewayIp01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", - "properties": { - "provisioningState": "Succeeded", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" - } - } - } - ], - "sslCertificates": [], - "authenticationCertificates": [], - "frontendIPConfigurations": [ - { - "name": "FrontEndConfig01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", - "properties": { - "provisioningState": "Succeeded", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" - } - } - } - ], - "frontendPorts": [ - { - "name": "FrontEndPort01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", - "properties": { - "provisioningState": "Succeeded", - "port": 80 - } - } - ], - "backendAddressPools": [ - { - "name": "Pool01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", - "properties": { - "provisioningState": "Succeeded", - "backendAddresses": [ - { - "ipAddress": "10.10.10.1" - }, - { - "ipAddress": "10.10.10.2" - }, - { - "ipAddress": "10.10.10.3" - } - ] - } - } - ], - "backendHttpSettingsCollection": [ - { - "name": "PoolSetting01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", - "properties": { - "provisioningState": "Succeeded", - "port": 80, - "protocol": "Http", - "cookieBasedAffinity": "Disabled", - "pickHostNameFromBackendAddress": false, - "requestTimeout": 30 - } - } - ], - "httpListeners": [ - { - "name": "listener1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" - }, - "frontendPort": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" - }, - "protocol": "Http", - "requireServerNameIndication": false - } - } - ], - "urlPathMaps": [], - "requestRoutingRules": [ - { - "name": "Rule01", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", - "properties": { - "provisioningState": "Succeeded", - "ruleType": "Basic", - "httpListener": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" - }, - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" - }, - "backendHttpSettings": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" - } - } - } - ], - "probes": [], - "redirectConfigurations": [] - } - } - } - } +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationGatewayName" : "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ExpressRouteCircuitUpdateTags.json index 0ea57ab235cd..54a8bd2a5bfa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ExpressRouteCircuitUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/ExpressRouteCircuitUpdateTags.json @@ -1,48 +1,48 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "ertest", - "circuitName" : "er1", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "er1", - "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", - "type": "Microsoft.Network/expressRouteCircuits", - "location": "brazilsouth", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Failed", - "peerings": [], - "authorizations": [], - "serviceProviderProperties": { - "serviceProviderName": "Equinix", - "peeringLocation": "Silicon Valley", - "bandwidthInMbps": 1000 - }, - "circuitProvisioningState": "Enabled", - "allowClassicOperations": false, - "gatewayManagerEtag": "", - "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", - "serviceProviderProvisioningState": "NotProvisioned" - }, - "sku": { - "name": "Standard_MeteredData", - "tier": "Standard", - "family": "MeteredData" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "ertest", + "circuitName" : "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LoadBalancerUpdateTags.json index c08c9db399ef..3c1a838047e4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LoadBalancerUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LoadBalancerUpdateTags.json @@ -1,132 +1,132 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "loadBalancerName" : "lb", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", - "type": "Microsoft.Network/loadBalancers", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfigurations": [ - { - "name": "fe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.1.4", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" - }, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ], - "inboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" - } - ] - } - } - ], - "backendAddressPools": [ - { - "name": "be-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", - "properties": { - "provisioningState": "Succeeded", - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "loadBalancingRules": [ - { - "name": "rulelb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 80, - "backendPort": 80, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp", - "loadDistribution": "Default", - "backendAddressPool": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" - }, - "probe": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" - }, - "disableOutboundSnat": false - } - } - ], - "probes": [ - { - "name": "probe-lb", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", - "properties": { - "provisioningState": "Succeeded", - "protocol": "Http", - "port": 80, - "requestPath": "healthcheck.aspx", - "intervalInSeconds": 15, - "numberOfProbes": 2, - "loadBalancingRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" - } - ] - } - } - ], - "inboundNatRules": [ - { - "name": "in-nat-rule", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", - "properties": { - "provisioningState": "Succeeded", - "frontendIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" - }, - "frontendPort": 3389, - "backendPort": 3389, - "enableFloatingIP": true, - "idleTimeoutInMinutes": 15, - "protocol": "Tcp" - } - } - ], - "outboundNatRules": [], - "inboundNatPools": [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundNatRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LocalNetworkGatewayUpdateTags.json index 6bb0828bac7b..7e17d508ae7a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LocalNetworkGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/LocalNetworkGatewayUpdateTags.json @@ -1,38 +1,38 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "localNetworkGatewayName": "lgw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "lgw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", - "type": "Microsoft.Network/localNetworkGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "localNetworkAddressSpace": { - "addressPrefixes": [ - "12.0.0.0/8" - ] - }, - "gatewayIpAddress": "12.0.0.1" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkInterfaceUpdateTags.json index e775aea65b32..5664d275ecd7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkInterfaceUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkInterfaceUpdateTags.json @@ -1,55 +1,55 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "networkInterfaceName": "test-nic", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-nic", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", - "location" : "eastus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded", - "ipConfigurations" : [{ - "name" : "ipconfig1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", - "properties" : { - "provisioningState" : "Succeeded", - "privateIPAddress" : "172.20.2.4", - "privateIPAllocationMethod" : "Dynamic", - "publicIPAddress" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" - }, - "subnet" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" - }, - "primary" : true, - "privateIPAddressVersion" : "IPv4" - } - } - ], - "dnsSettings" : { - "dnsServers" : [], - "appliedDnsServers" : [] - }, - "enableAcceleratedNetworking" : true, - "enableIPForwarding" : false - }, - "type" : "Microsoft.Network/networkInterfaces" - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkSecurityGroupUpdateTags.json index 5c67f8f89dbf..3f01def8185c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkSecurityGroupUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkSecurityGroupUpdateTags.json @@ -1,130 +1,130 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkSecurityGroupName" : "testnsg", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testnsg", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", - "type": "Microsoft.Network/networkSecurityGroups", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "securityRules": [ ], - "defaultSecurityRules": [ - { - "name": "AllowVnetInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Inbound" - } - }, - { - "name": "AllowAzureLoadBalancerInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow inbound traffic from azure load balancer", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "AzureLoadBalancer", - "destinationAddressPrefix": "*", - "access": "Allow", - "priority": 65001, - "direction": "Inbound" - } - }, - { - "name": "DenyAllInBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all inbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Inbound" - } - }, - { - "name": "AllowVnetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to all VMs in VNET", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "VirtualNetwork", - "destinationAddressPrefix": "VirtualNetwork", - "access": "Allow", - "priority": 65000, - "direction": "Outbound" - } - }, - { - "name": "AllowInternetOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Allow outbound traffic from all VMs to Internet", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "Internet", - "access": "Allow", - "priority": 65001, - "direction": "Outbound" - } - }, - { - "name": "DenyAllOutBound", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", - "properties": { - "provisioningState": "Succeeded", - "description": "Deny all outbound traffic", - "protocol": "*", - "sourcePortRange": "*", - "destinationPortRange": "*", - "sourceAddressPrefix": "*", - "destinationAddressPrefix": "*", - "access": "Deny", - "priority": 65500, - "direction": "Outbound" - } - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherUpdateTags.json index 474a3f1c1354..fcdd1103556f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherUpdateTags.json @@ -1,32 +1,32 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "networkWatcherName" : "nw1", - "parameters" : { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "nw1", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", - "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", - "type" : "Microsoft.Network/networkWatchers", - "location" : "eastus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded" - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/OperationList.json index 4451f1e6654c..86113b9b55b8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/OperationList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/OperationList.json @@ -1,137 +1,137 @@ -{ - "parameters": { - "location": "westus", - "api-version": "2017-10-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.Network/localnetworkgateways/read", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Get LocalNetworkGateway", - "description": "Gets LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/localnetworkgateways/write", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Create or update LocalNetworkGateway", - "description": "Creates or updates an existing LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/localnetworkgateways/delete", - "display": { - "provider": "Microsoft Network", - "resource": "LocalNetworkGateway", - "operation": "Delete LocalNetworkGateway", - "description": "Deletes LocalNetworkGateway" - } - }, - { - "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", - "display": { - "provider": "Microsoft Network", - "resource": "Network Interface metric definition", - "operation": "Read Network Interface metric definitions", - "description": "Gets available metrics for the Network Interface" - }, - "origin": "system", - "properties": { - "serviceSpecification": { - "metricSpecifications": [ - { - "name": "BytesSentRate", - "displayName": "Bytes Sent", - "displayDescription": "Number of bytes the Network Interface sent", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "00:01:00", - "retention": "00:00:00", - "blobDuration": "01:00:00" - }, - { - "timeGrain": "01:00:00", - "retention": "00:00:00", - "blobDuration": "1.00:00:00" - } - ], - "enableRegionalMdmAccount": false, - "metricFilterPattern": "^__Ready__$", - "fillGapWithZero": false, - "dimensions": [], - "isInternal": false - }, - { - "name": "BytesReceivedRate", - "displayName": "Bytes Received", - "displayDescription": "Number of bytes the Network Interface received", - "unit": "Count", - "aggregationType": "Total", - "availabilities": [ - { - "timeGrain": "00:01:00", - "retention": "00:00:00", - "blobDuration": "01:00:00" - }, - { - "timeGrain": "01:00:00", - "retention": "00:00:00", - "blobDuration": "1.00:00:00" - } - ], - "enableRegionalMdmAccount": false, - "metricFilterPattern": "^__Ready__$", - "fillGapWithZero": false, - "dimensions": [], - "isInternal": false - } - ] - } - } - }, - { - "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", - "display": { - "provider": "Microsoft Network", - "resource": "Network Security Groups Log Definitions", - "operation": "Get Network Security Group Event Log Definitions", - "description": "Gets the events for network security group" - }, - "origin": "system", - "properties": { - "serviceSpecification": { - "logSpecifications": [ - { - "name": "NetworkSecurityGroupEvent", - "displayName": "Network Security Group Event", - "blobDuration": "PT1H" - }, - { - "name": "NetworkSecurityGroupRuleCounter", - "displayName": "Network Security Group Rule Counter", - "blobDuration": "PT1H" - }, - { - "name": "NetworkSecurityGroupFlowEvent", - "displayName": "Network Security Group Rule Flow Event", - "blobDuration": "PT1H" - } - ] - } - } - } - ] - } - } - } +{ + "parameters": { + "location": "westus", + "api-version": "2017-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/PublicIpAddressUpdateTags.json index 5ede13708926..e3a7b79c86da 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/PublicIpAddressUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/PublicIpAddressUpdateTags.json @@ -1,37 +1,37 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName": "rg1", - "publicIpAddressName": "test-ip", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "testDNS-ip", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", - "location" : "westus", - "properties" : { - "provisioningState" : "Succeeded", - "publicIPAddressVersion" : "IPv4", - "publicIPAllocationMethod" : "Static", - "idleTimeoutInMinutes" : 10, - "ipConfiguration" : { - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" - } - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "type" : "Microsoft.Network/publicIPAddresses" - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/RouteTableUpdateTags.json index bf3a8d72a84f..3f5ea94a9797 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/RouteTableUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/RouteTableUpdateTags.json @@ -1,32 +1,32 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "routeTableName" : "testrt", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "testrt", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", - "type": "Microsoft.Network/routeTables", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "routes": [ ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json index ba848edb4501..a4fb2ce35d6f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -1,47 +1,47 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkGatewayConnectionName": "test", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "test", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", - "type": "Microsoft.Network/connections", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "virtualNetworkGateway1": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw" - }, - "localNetworkGateway2": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw" - }, - "connectionType": "IPsec", - "routingWeight": 0, - "sharedKey": "temp1234", - "enableBgp": false, - "usePolicyBasedTrafficSelectors": false, - "ipsecPolicies": [], - "connectionStatus": "Unknown", - "ingressBytesTransferred": 0, - "egressBytesTransferred": 0 - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw" + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw" + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayUpdateTags.json index 58c785779dca..6345cbd51e89 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -1,62 +1,62 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkGatewayName" : "vpngw", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name": "vpngw", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", - "type": "Microsoft.Network/virtualNetworkGateways", - "location": "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties": { - "provisioningState": "Succeeded", - "resourceGuid": "00000000-0000-0000-0000-000000000000", - "ipConfigurations": [ - { - "name": "default", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", - "properties": { - "provisioningState": "Succeeded", - "privateIPAllocationMethod": "Dynamic", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" - }, - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" - } - } - } - ], - "sku": { - "name": "VpnGw1", - "tier": "VpnGw1", - "capacity": 2 - }, - "gatewayType": "Vpn", - "vpnType": "RouteBased", - "enableBgp": false, - "activeActive": false, - "bgpSettings": { - "asn": 65515, - "bgpPeeringAddress": "10.0.0.254", - "peerWeight": 0 - } - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkUpdateTags.json index 2a818d410ebf..3dd1213ebbf5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VirtualNetworkUpdateTags.json @@ -1,39 +1,39 @@ -{ - "parameters" : { - "api-version" : "2017-10-01", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualNetworkName" : "test-vnet", - "location": "westus", - "parameters": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses" : { - "200" : { - "body" : { - "name" : "test-vnet", - "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", - "type" : "Microsoft.Network/virtualNetworks", - "location" : "westus", - "tags": { - "tag1": "value1", - "tag2": "value2" - }, - "properties" : { - "provisioningState" : "Succeeded", - "addressSpace" : { - "addressPrefixes" : [ - "10.0.0.0/16" - ] - }, - "subnets" : [], - "virtualNetworkPeerings" : [] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigGet.json index 7eda8f4cdf2b..50253777dc63 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -1,39 +1,39 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "2", - "networkInterfaceName": "nic1", - "ipConfigurationName": "ip1" - }, - "responses" : { - "200" : { - "body" : { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.6", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" - } - ] - } - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses" : { + "200" : { + "body" : { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigList.json index 4ad2afcbe0fa..fe4db041f128 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -1,42 +1,42 @@ -{ - "parameters" : { - "api-version" : "2017-03-30", - "subscriptionId" : "subid", - "resourceGroupName" : "rg1", - "virtualMachineScaleSetName": "vmss1", - "virtualmachineIndex": "2", - "networkInterfaceName": "nic1" - }, - "responses" : { - "200" : { - "body" : { - "value": [ - { - "name": "ip1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", - "properties": { - "provisioningState": "Succeeded", - "privateIPAddress": "10.0.0.6", - "privateIPAllocationMethod": "Dynamic", - "subnet": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" - }, - "primary": true, - "privateIPAddressVersion": "IPv4", - "loadBalancerBackendAddressPools": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" - } - ], - "loadBalancerInboundNatRules": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" - } - ] - } - } - ] - } - } - } -} +{ + "parameters" : { + "api-version" : "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/operation.json index 1854ea67160d..b54fa33eec75 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/operation.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/operation.json @@ -1,279 +1,279 @@ -{ - "swagger": "2.0", - "info": { - "title": "NetworkManagementClient", - "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", - "version": "2017-10-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Network/operations": { - "get": { - "operationId": "Operations_List", - "description": "Lists all of the available Network Rest API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Network operations supported by the Network resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "Network REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft Network.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "Type of the operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of the operation.", - "type": "string" - } - } - }, - "origin": { - "description": "Origin of the operation.", - "type": "string" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/OperationPropertiesFormat", - "description": "Operation properties format." - } - } - }, - "OperationPropertiesFormat": { - "description": "Description of operation properties format.", - "properties": { - "serviceSpecification": { - "description": "Specification of the service.", - "properties": { - "metricSpecifications": { - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - }, - "description": "Operation service specification." - }, - "logSpecifications": { - "type": "array", - "items": { - "$ref": "#/definitions/LogSpecification" - }, - "description": "Operation log specification." - } - } - } - } - }, - "LogSpecification": { - "description": "Description of logging specification.", - "properties": { - "name": { - "type": "string", - "description": "The name of the specification." - }, - "displayName": { - "type": "string", - "description": "The display name of the specification." - }, - "blobDuration": { - "type": "string", - "description": "Duration of the blob." - } - } - }, - "MetricSpecification": { - "description": "Description of metrics specification.", - "properties": { - "name": { - "type": "string", - "description": "The name of the metric." - }, - "displayName": { - "type": "string", - "description": "The display name of the metric." - }, - "displayDescription": { - "type": "string", - "description": "The description of the metric." - }, - "unit": { - "type": "string", - "description": "Units the metric to be displayed in." - }, - "aggregationType": { - "type": "string", - "description": "The aggregation type." - }, - "availabilities": { - "type": "array", - "items": { - "$ref": "#/definitions/Availability" - }, - "description": "List of availability." - }, - "enableRegionalMdmAccount": { - "type": "boolean", - "description": "Whether regional MDM account enabled." - }, - "fillGapWithZero": { - "type": "boolean", - "description": "Whether gaps would be filled with zeros." - }, - "metricFilterPattern": { - "type": "string", - "description": "Pattern for the filter of the metric." - }, - "dimensions": { - "type": "array", - "items": { - "$ref": "#/definitions/Dimension" - }, - "description": "List of dimensions." - }, - "isInternal": { - "type": "boolean", - "description": "Whether the metric is internal." - }, - "sourceMdmAccount": { - "type": "string", - "description": "The source MDM account." - }, - "sourceMdmNamespace": { - "type": "string", - "description": "The source MDM namespace." - }, - "resourceIdDimensionNameOverride": { - "type": "string", - "description": "The resource Id dimension name override." - } - } - }, - "Dimension": { - "description": "Dimension of the metric.", - "properties": { - "name": { - "type": "string", - "description": "The name of the dimension." - }, - "displayName": { - "type": "string", - "description": "The display name of the dimension." - }, - "internalName": { - "type": "string", - "description": "The internal name of the dimension." - } - } - }, - "Availability": { - "description": "Availability of the metric.", - "properties": { - "timeGrain": { - "type": "string", - "description": "The time grain of the availability." - }, - "retention": { - "type": "string", - "description": "The retention of the availability." - }, - "blobDuration": { - "type": "string", - "description": "Duration of the availability blob." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/usage.json index 970a257ba107..064bd6beb829 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/usage.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/usage.json @@ -48,7 +48,7 @@ "required": true, "type": "string", "description": "The location where resource usage is queried.", - "pattern": "^[-\\w\\._ ]+$" + "pattern": "^[-\\w\\._ ]+$" }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -66,8 +66,8 @@ } }, "x-ms-examples": { - "List usages": { "$ref": "./examples/UsageList.json" }, - "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } + "List usages": { "$ref": "./examples/UsageList.json" }, + "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json index c255a2f2f8ac..cceac8b75f2f 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json @@ -1,368 +1,368 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-06-01", - "title": "RecoveryServicesClient", - "x-ms-code-generation-settings": { - "internalConstructors": false - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}": { - "put": { - "tags": [ - "VaultCertificates" - ], - "description": "Uploads a certificate for a resource.", - "operationId": "VaultCertificates_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "name": "certificateName", - "in": "path", - "description": "Certificate friendly name.", - "required": true, - "type": "string" - }, - { - "name": "certificateRequest", - "in": "body", - "description": "Input parameters for uploading the vault certificate.", - "required": true, - "schema": { - "$ref": "#/definitions/CertificateRequest" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultCertificateResponse" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Download vault credential file": { - "$ref": "./examples/PUTVaultCred.json" - } - } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}": { - "delete": { - "tags": [ - "RegisteredIdentities" - ], - "description": "Unregisters the given container from your Recovery Services vault.", - "operationId": "RegisteredIdentities_Delete", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "name": "identityName", - "in": "path", - "description": "Name of the protection container to unregister.", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "NoContent" - } - }, - "deprecated": false, - "x-ms-examples": { - "Delete registered Identity": { - "$ref": "./examples/DeleteRegisteredIdentities.json" - } - } - } - } - }, - "definitions": { - "CertificateRequest": { - "description": "Details of the certificate to be uploaded to the vault.", - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/RawCertificateData" - } - } - }, - "RawCertificateData": { - "description": "Raw certificate data.", - "type": "object", - "properties": { - "authType": { - "description": "Specifies the authentication type.", - "enum": [ - "Invalid", - "ACS", - "AAD", - "AccessControlService", - "AzureActiveDirectory" - ], - "type": "string", - "x-ms-enum": { - "name": "AuthType", - "modelAsString": true - } - }, - "certificate": { - "format": "byte", - "description": "The base64 encoded certificate raw data string", - "type": "string" - } - } - }, - "ResourceCertificateAndAadDetails": { - "description": "Certificate details representing the Vault credentials for AAD.", - "required": [ - "certificate", - "resourceId", - "aadAuthority", - "aadTenantId", - "servicePrincipalClientId", - "servicePrincipalObjectId", - "azureManagementEndpointAudience", - "subject", - "validFrom", - "validTo", - "thumbprint", - "friendlyName", - "issuer" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceCertificateDetails" - } - ], - "properties": { - "aadAuthority": { - "description": "AAD tenant authority.", - "type": "string" - }, - "aadTenantId": { - "description": "AAD tenant Id.", - "type": "string" - }, - "servicePrincipalClientId": { - "description": "AAD service principal clientId.", - "type": "string" - }, - "servicePrincipalObjectId": { - "description": "AAD service principal ObjectId.", - "type": "string" - }, - "azureManagementEndpointAudience": { - "description": "Azure Management Endpoint Audience.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AzureActiveDirectory" - }, - "ResourceCertificateAndAcsDetails": { - "description": "Certificate details representing the Vault credentials for ACS.", - "required": [ - "certificate", - "resourceId", - "globalAcsNamespace", - "globalAcsHostName", - "globalAcsRPRealm", - "subject", - "validFrom", - "validTo", - "thumbprint", - "friendlyName", - "issuer" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ResourceCertificateDetails" - } - ], - "properties": { - "globalAcsNamespace": { - "description": "ACS namespace name - tenant for our service.", - "type": "string" - }, - "globalAcsHostName": { - "description": "Acs mgmt host name to connect to.", - "type": "string" - }, - "globalAcsRPRealm": { - "description": "Global ACS namespace RP realm.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AccessControlService" - }, - "ResourceCertificateDetails": { - "description": "Certificate details representing the Vault credentials.", - "required": [ - "authType" - ], - "type": "object", - "properties": { - "authType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", - "type": "string" - }, - "certificate": { - "format": "byte", - "description": "The base64 encoded certificate raw data string.", - "type": "string" - }, - "friendlyName": { - "description": "Certificate friendlyname.", - "type": "string" - }, - "issuer": { - "description": "Certificate issuer.", - "type": "string" - }, - "resourceId": { - "format": "int64", - "description": "Resource ID of the vault.", - "type": "integer" - }, - "subject": { - "description": "Certificate Subject Name.", - "type": "string" - }, - "thumbprint": { - "description": "Certificate thumbprint.", - "type": "string" - }, - "validFrom": { - "format": "date-time", - "description": "Certificate Validity start Date time.", - "type": "string" - }, - "validTo": { - "format": "date-time", - "description": "Certificate Validity End Date time.", - "type": "string" - } - }, - "discriminator": "authType" - }, - "VaultCertificateResponse": { - "description": "Certificate corresponding to a vault that can be used by clients to register themselves with the vault.", - "type": "object", - "properties": { - "name": { - "description": "Resource name associated with the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", - "type": "string", - "readOnly": true - }, - "id": { - "description": "Resource Id represents the complete path to the resource.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/ResourceCertificateDetails" - } - }, - "x-ms-azure-resource": true - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription Id.", - "required": true, - "type": "string" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group where the recovery services vault is present.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "VaultName": { - "name": "vaultName", - "in": "path", - "description": "The name of the recovery services vault.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account." - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "version": "2016-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}": { + "put": { + "tags": [ + "VaultCertificates" + ], + "description": "Uploads a certificate for a resource.", + "operationId": "VaultCertificates_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "certificateName", + "in": "path", + "description": "Certificate friendly name.", + "required": true, + "type": "string" + }, + { + "name": "certificateRequest", + "in": "body", + "description": "Input parameters for uploading the vault certificate.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultCertificateResponse" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Download vault credential file": { + "$ref": "./examples/PUTVaultCred.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}": { + "delete": { + "tags": [ + "RegisteredIdentities" + ], + "description": "Unregisters the given container from your Recovery Services vault.", + "operationId": "RegisteredIdentities_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "identityName", + "in": "path", + "description": "Name of the protection container to unregister.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "deprecated": false, + "x-ms-examples": { + "Delete registered Identity": { + "$ref": "./examples/DeleteRegisteredIdentities.json" + } + } + } + } + }, + "definitions": { + "CertificateRequest": { + "description": "Details of the certificate to be uploaded to the vault.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + } + }, + "RawCertificateData": { + "description": "Raw certificate data.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies the authentication type.", + "enum": [ + "Invalid", + "ACS", + "AAD", + "AccessControlService", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string", + "type": "string" + } + } + }, + "ResourceCertificateAndAadDetails": { + "description": "Certificate details representing the Vault credentials for AAD.", + "required": [ + "certificate", + "resourceId", + "aadAuthority", + "aadTenantId", + "servicePrincipalClientId", + "servicePrincipalObjectId", + "azureManagementEndpointAudience", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "aadAuthority": { + "description": "AAD tenant authority.", + "type": "string" + }, + "aadTenantId": { + "description": "AAD tenant Id.", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "AAD service principal clientId.", + "type": "string" + }, + "servicePrincipalObjectId": { + "description": "AAD service principal ObjectId.", + "type": "string" + }, + "azureManagementEndpointAudience": { + "description": "Azure Management Endpoint Audience.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "ResourceCertificateAndAcsDetails": { + "description": "Certificate details representing the Vault credentials for ACS.", + "required": [ + "certificate", + "resourceId", + "globalAcsNamespace", + "globalAcsHostName", + "globalAcsRPRealm", + "subject", + "validFrom", + "validTo", + "thumbprint", + "friendlyName", + "issuer" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceCertificateDetails" + } + ], + "properties": { + "globalAcsNamespace": { + "description": "ACS namespace name - tenant for our service.", + "type": "string" + }, + "globalAcsHostName": { + "description": "Acs mgmt host name to connect to.", + "type": "string" + }, + "globalAcsRPRealm": { + "description": "Global ACS namespace RP realm.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AccessControlService" + }, + "ResourceCertificateDetails": { + "description": "Certificate details representing the Vault credentials.", + "required": [ + "authType" + ], + "type": "object", + "properties": { + "authType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "type": "string" + }, + "certificate": { + "format": "byte", + "description": "The base64 encoded certificate raw data string.", + "type": "string" + }, + "friendlyName": { + "description": "Certificate friendlyname.", + "type": "string" + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string" + }, + "resourceId": { + "format": "int64", + "description": "Resource ID of the vault.", + "type": "integer" + }, + "subject": { + "description": "Certificate Subject Name.", + "type": "string" + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string" + }, + "validFrom": { + "format": "date-time", + "description": "Certificate Validity start Date time.", + "type": "string" + }, + "validTo": { + "format": "date-time", + "description": "Certificate Validity End Date time.", + "type": "string" + } + }, + "discriminator": "authType" + }, + "VaultCertificateResponse": { + "description": "Certificate corresponding to a vault that can be used by clients to register themselves with the vault.", + "type": "object", + "properties": { + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ResourceCertificateDetails" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json index 28e080cb68c3..a7b1a3fc220a 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json @@ -1,208 +1,208 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-06-01", - "title": "RecoveryServicesClient", - "x-ms-code-generation-settings": { - "internalConstructors": false - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages": { - "get": { - "tags": [ - "ReplicationUsages" - ], - "description": "Fetches the replication usages of the vault.", - "operationId": "ReplicationUsages_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ReplicationUsageList" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets Replication usages of vault": { - "$ref": "./examples/ListReplicationUsages.json" - } - } - } - } - }, - "definitions": { - "JobsSummary": { - "description": "Summary of the replication job data for this vault.", - "type": "object", - "properties": { - "failedJobs": { - "description": "Count of failed jobs.", - "type": "integer" - }, - "suspendedJobs": { - "description": "Count of suspended jobs.", - "type": "integer" - }, - "inProgressJobs": { - "description": "Count of in-progress jobs.", - "type": "integer" - } - } - }, - "MonitoringSummary": { - "description": "Summary of the replication monitoring data for this vault.", - "type": "object", - "properties": { - "unHealthyVmCount": { - "description": "Count of unhealthy VMs.", - "type": "integer" - }, - "unHealthyProviderCount": { - "description": "Count of unhealthy replication providers.", - "type": "integer" - }, - "eventsCount": { - "description": "Count of all critical warnings.", - "type": "integer" - }, - "deprecatedProviderCount": { - "description": "Count of all deprecated recovery service providers.", - "type": "integer" - }, - "supportedProviderCount": { - "description": "Count of all the supported recovery service providers.", - "type": "integer" - }, - "unsupportedProviderCount": { - "description": "Count of all the unsupported recovery service providers.", - "type": "integer" - } - } - }, - "ReplicationUsage": { - "description": "Replication usages of a vault.", - "type": "object", - "properties": { - "monitoringSummary": { - "$ref": "#/definitions/MonitoringSummary", - "description": "Summary of the replication monitoring data for this vault." - }, - "jobsSummary": { - "$ref": "#/definitions/JobsSummary", - "description": "Summary of the replication jobs data for this vault." - }, - "protectedItemCount": { - "description": "Number of replication protected items for this vault.", - "type": "integer" - }, - "recoveryPlanCount": { - "description": "Number of replication recovery plans for this vault.", - "type": "integer" - }, - "registeredServersCount": { - "description": "Number of servers registered to this vault.", - "type": "integer" - }, - "recoveryServicesProviderAuthType": { - "description": "The authentication type of recovery service providers in the vault.", - "type": "integer" - } - } - }, - "ReplicationUsageList": { - "description": "Replication usages for vault.", - "type": "object", - "properties": { - "value": { - "description": "The list of replication usages for the given vault.", - "type": "array", - "items": { - "$ref": "#/definitions/ReplicationUsage" - } - } - } - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription Id.", - "required": true, - "type": "string" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group where the recovery services vault is present.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "VaultName": { - "name": "vaultName", - "in": "path", - "description": "The name of the recovery services vault.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account." - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "version": "2016-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages": { + "get": { + "tags": [ + "ReplicationUsages" + ], + "description": "Fetches the replication usages of the vault.", + "operationId": "ReplicationUsages_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets Replication usages of vault": { + "$ref": "./examples/ListReplicationUsages.json" + } + } + } + } + }, + "definitions": { + "JobsSummary": { + "description": "Summary of the replication job data for this vault.", + "type": "object", + "properties": { + "failedJobs": { + "description": "Count of failed jobs.", + "type": "integer" + }, + "suspendedJobs": { + "description": "Count of suspended jobs.", + "type": "integer" + }, + "inProgressJobs": { + "description": "Count of in-progress jobs.", + "type": "integer" + } + } + }, + "MonitoringSummary": { + "description": "Summary of the replication monitoring data for this vault.", + "type": "object", + "properties": { + "unHealthyVmCount": { + "description": "Count of unhealthy VMs.", + "type": "integer" + }, + "unHealthyProviderCount": { + "description": "Count of unhealthy replication providers.", + "type": "integer" + }, + "eventsCount": { + "description": "Count of all critical warnings.", + "type": "integer" + }, + "deprecatedProviderCount": { + "description": "Count of all deprecated recovery service providers.", + "type": "integer" + }, + "supportedProviderCount": { + "description": "Count of all the supported recovery service providers.", + "type": "integer" + }, + "unsupportedProviderCount": { + "description": "Count of all the unsupported recovery service providers.", + "type": "integer" + } + } + }, + "ReplicationUsage": { + "description": "Replication usages of a vault.", + "type": "object", + "properties": { + "monitoringSummary": { + "$ref": "#/definitions/MonitoringSummary", + "description": "Summary of the replication monitoring data for this vault." + }, + "jobsSummary": { + "$ref": "#/definitions/JobsSummary", + "description": "Summary of the replication jobs data for this vault." + }, + "protectedItemCount": { + "description": "Number of replication protected items for this vault.", + "type": "integer" + }, + "recoveryPlanCount": { + "description": "Number of replication recovery plans for this vault.", + "type": "integer" + }, + "registeredServersCount": { + "description": "Number of servers registered to this vault.", + "type": "integer" + }, + "recoveryServicesProviderAuthType": { + "description": "The authentication type of recovery service providers in the vault.", + "type": "integer" + } + } + }, + "ReplicationUsageList": { + "description": "Replication usages for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of replication usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationUsage" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json index 6d377229587f..443c70f9f62a 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json @@ -1,884 +1,884 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-06-01", - "title": "RecoveryServicesClient", - "x-ms-code-generation-settings": { - "internalConstructors": false - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults": { - "get": { - "tags": [ - "Vaults" - ], - "description": "Fetches all the resources of the specified type in the subscription.", - "operationId": "Vaults_ListBySubscriptionId", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultList" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "List of Recovery Services Resources in SubscriptionId": { - "$ref": "./examples/ListBySubscriptionIds.json" - } - } - } - }, - "/providers/Microsoft.RecoveryServices/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Returns the list of available operations.", - "operationId": "Operations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClientDiscoveryResponse" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" - }, - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/ListOperations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults": { - "get": { - "tags": [ - "Vaults" - ], - "description": "Retrieve a list of Vaults.", - "operationId": "Vaults_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultList" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName":"value" - }, - "x-ms-examples": { - "List of Recovery Services Resources in ResourceGroup": { - "$ref": "./examples/ListResources.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}": { - "get": { - "tags": [ - "Vaults" - ], - "description": "Get the Vault details.", - "operationId": "Vaults_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Vault" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Get Recovery Services Resource": { - "$ref": "./examples/GETVault.json" - } - } - }, - "put": { - "tags": [ - "Vaults" - ], - "description": "Creates or updates a Recovery Services vault.", - "operationId": "Vaults_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "name": "vault", - "in": "body", - "description": "Recovery Services Vault to be created.", - "required": true, - "schema": { - "$ref": "#/definitions/Vault" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Vault" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Vault" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Create of Update Recovery Services vault": { - "$ref": "./examples/PUTVault.json" - } - } - }, - "delete": { - "tags": [ - "Vaults" - ], - "description": "Deletes a vault.", - "operationId": "Vaults_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "deprecated": false, - "x-ms-examples":{ - "Delete Recovery Services Vault": { - "$ref": "./examples/DeleteVault.json" - } - } - }, - "patch": { - "tags": [ - "Vaults" - ], - "description": "Updates the vault.", - "operationId": "Vaults_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "name": "vault", - "in": "body", - "description": "Recovery Services Vault to be created.", - "required": true, - "schema": { - "$ref": "#/definitions/PatchVault" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Vault" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Vault" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Update Resource": { - "$ref": "./examples/PATCHVault.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo": { - "get": { - "tags": [ - "VaultExtendedInfo" - ], - "description": "Get the vault extended info.", - "operationId": "VaultExtendedInfo_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultExtendedInfoResource" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Get ExtendedInfo of Resource": { - "$ref": "./examples/GETVaultExtendedInfo.json" - } - } - }, - "put": { - "tags": [ - "VaultExtendedInfo" - ], - "description": "Create vault extended info.", - "operationId": "VaultExtendedInfo_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "resourceResourceExtendedInfoDetails", - "in": "body", - "description": "Details of ResourceExtendedInfo", - "required": true, - "schema": { - "$ref": "#/definitions/VaultExtendedInfoResource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultExtendedInfoResource" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "Put ExtendedInfo of Resource": { - "$ref": "./examples/UpdateVaultExtendedInfo.json" - } - } - }, - "patch": { - "tags": [ - "VaultExtendedInfo" - ], - "description": "Update vault extended info.", - "operationId": "VaultExtendedInfo_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "name": "resourceResourceExtendedInfoDetails", - "in": "body", - "description": "Details of ResourceExtendedInfo", - "required": true, - "schema": { - "$ref": "#/definitions/VaultExtendedInfoResource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultExtendedInfoResource" - } - } - }, - "deprecated": false, - "x-ms-examples": { - "PATCH ExtendedInfo of Resource": { - "$ref": "./examples/UpdateVaultExtendedInfo.json" - } - } - } - } - }, - "definitions": { - "ClientDiscoveryDisplay": { - "description": "Localized display information of an operation.", - "type": "object", - "properties": { - "provider": { - "description": "Name of the provider for display purposes", - "type": "string" - }, - "resource": { - "description": "ResourceType for which this Operation can be performed.", - "type": "string" - }, - "operation": { - "description": "Operations Name itself.", - "type": "string" - }, - "description": { - "description": "Description of the operation having details of what operation is about.", - "type": "string" - } - } - }, - "ClientDiscoveryForLogSpecification": { - "description": "Class to represent shoebox log specification in json client discovery.", - "type": "object", - "properties": { - "name": { - "description": "Name of the log.", - "type": "string" - }, - "displayName": { - "description": "Localized display name", - "type": "string" - }, - "blobDuration": { - "description": "Blobs created in customer storage account per hour", - "type": "string" - } - } - }, - "ClientDiscoveryForProperties": { - "description": "Class to represent shoebox properties in json client discovery.", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", - "description": "Operation properties." - } - } - }, - "ClientDiscoveryForServiceSpecification": { - "description": "Class to represent shoebox service specification in json client discovery.", - "type": "object", - "properties": { - "logSpecifications": { - "description": "List of log specifications of this operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ClientDiscoveryForLogSpecification" - } - } - } - }, - "ClientDiscoveryResponse": { - "description": "Operations List response which contains list of available APIs.", - "type": "object", - "properties": { - "value": { - "description": "List of available operationss.", - "type": "array", - "items": { - "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" - } - }, - "nextLink": { - "description": "Link to the next chunk of the response", - "type": "string" - } - } - }, - "ClientDiscoveryValueForSingleApi": { - "description": "Available operation details.", - "type": "object", - "properties": { - "name": { - "description": "Name of the Operation.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/ClientDiscoveryDisplay", - "description": "Contains the localized display information for this particular operation" - }, - "origin": { - "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/ClientDiscoveryForProperties", - "description": "ShoeBox properties for the given operation." - } - } - }, - "Resource": { - "description": "ARM Resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource Id represents the complete path to the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name associated with the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", - "type": "string", - "readOnly": true - }, - "eTag": { - "description": "Optional ETag.", - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "Sku": { - "description": "Identifies the unique system identifier for each Azure resource.", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The Sku name.", - "enum": [ - "Standard", - "RS0" - ], - "type": "string", - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - } - } - }, - "TrackedResource": { - "description": "Tracked resource with location.", - "type": "object", - "required": [ - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties":{ - "location": { - "description": "Resource location.", - "type": "string" - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "PatchTrackedResource": { - "description": "Tracked resource with location.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties":{ - "location": { - "description": "Resource location.", - "type": "string" - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "UpgradeDetails": { - "description": "Details for upgrading vault.", - "type": "object", - "properties": { - "operationId": { - "description": "ID of the vault upgrade operation.", - "type": "string", - "readOnly": true - }, - "startTimeUtc": { - "description": "UTC time at which the upgrade operation has started.", - "type": "string", - "readOnly": true, - "format": "date-time" - }, - "lastUpdatedTimeUtc": { - "description": "UTC time at which the upgrade operation status was last updated.", - "type": "string", - "readOnly": true, - "format": "date-time" - }, - "endTimeUtc": { - "description": "UTC time at which the upgrade operation has ended.", - "type": "string", - "readOnly": true, - "format": "date-time" - }, - "status": { - "description": "Status of the vault upgrade operation.", - "enum": [ - "Unknown", - "InProgress", - "Upgraded", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "VaultUpgradeState", - "modelAsString": true - } - }, - "message": { - "description": "Message to the user containing information about the upgrade operation.", - "type": "string", - "readOnly": true - }, - "triggerType": { - "description": "The way the vault upgradation was triggered.", - "enum": [ - "UserTriggered", - "ForcedUpgrade" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "TriggerType", - "modelAsString": true - } - }, - "upgradedResourceId": { - "description": "Resource ID of the upgraded vault.", - "type": "string", - "readOnly": true - }, - "previousResourceId": { - "description": "Resource ID of the vault before the upgrade.", - "type": "string", - "readOnly": true - } - } - }, - "Vault": { - "description": "Resource information, as returned by the resource provider.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/VaultProperties" - }, - "sku": { - "$ref": "#/definitions/Sku" - } - } - }, - "PatchVault": { - "description": "Patch Resource information, as returned by the resource provider.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/PatchTrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/VaultProperties" - }, - "sku": { - "$ref": "#/definitions/Sku" - } - } - }, - "VaultExtendedInfo": { - "description": "Vault extended information.", - "type": "object", - "properties": { - "integrityKey": { - "description": "Integrity key.", - "type": "string" - }, - "encryptionKey": { - "description": "Encryption key.", - "type": "string" - }, - "encryptionKeyThumbprint": { - "description": "Encryption key thumbprint.", - "type": "string" - }, - "algorithm": { - "description": "Algorithm for Vault ExtendedInfo", - "type": "string" - } - } - }, - "VaultExtendedInfoResource": { - "description": "Vault extended information.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/VaultExtendedInfo", - "x-ms-client-flatten": true - } - } - }, - "VaultList": { - "description": "The response model for a list of Vaults.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Vault" - } - }, - "nextLink": { - "type": "string", - "readOnly": true - } - } - }, - "VaultProperties": { - "description": "Properties of the vault.", - "type": "object", - "properties": { - "provisioningState": { - "description": "Provisioning State.", - "type": "string", - "readOnly": true - }, - "upgradeDetails": { - "$ref": "#/definitions/UpgradeDetails" - } - } - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription Id.", - "required": true, - "type": "string" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group where the recovery services vault is present.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "VaultName": { - "name": "vaultName", - "in": "path", - "description": "The name of the recovery services vault.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account." - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "version": "2016-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Fetches all the resources of the specified type in the subscription.", + "operationId": "Vaults_ListBySubscriptionId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in SubscriptionId": { + "$ref": "./examples/ListBySubscriptionIds.json" + } + } + } + }, + "/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Retrieve a list of Vaults.", + "operationId": "Vaults_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName":"value" + }, + "x-ms-examples": { + "List of Recovery Services Resources in ResourceGroup": { + "$ref": "./examples/ListResources.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}": { + "get": { + "tags": [ + "Vaults" + ], + "description": "Get the Vault details.", + "operationId": "Vaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get Recovery Services Resource": { + "$ref": "./examples/GETVault.json" + } + } + }, + "put": { + "tags": [ + "Vaults" + ], + "description": "Creates or updates a Recovery Services vault.", + "operationId": "Vaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/Vault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Vault" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Create of Update Recovery Services vault": { + "$ref": "./examples/PUTVault.json" + } + } + }, + "delete": { + "tags": [ + "Vaults" + ], + "description": "Deletes a vault.", + "operationId": "Vaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "deprecated": false, + "x-ms-examples":{ + "Delete Recovery Services Vault": { + "$ref": "./examples/DeleteVault.json" + } + } + }, + "patch": { + "tags": [ + "Vaults" + ], + "description": "Updates the vault.", + "operationId": "Vaults_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "vault", + "in": "body", + "description": "Recovery Services Vault to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/PatchVault" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Vault" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Vault" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Update Resource": { + "$ref": "./examples/PATCHVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo": { + "get": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Get the vault extended info.", + "operationId": "VaultExtendedInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Get ExtendedInfo of Resource": { + "$ref": "./examples/GETVaultExtendedInfo.json" + } + } + }, + "put": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Create vault extended info.", + "operationId": "VaultExtendedInfo_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "Put ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + }, + "patch": { + "tags": [ + "VaultExtendedInfo" + ], + "description": "Update vault extended info.", + "operationId": "VaultExtendedInfo_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "resourceResourceExtendedInfoDetails", + "in": "body", + "description": "Details of ResourceExtendedInfo", + "required": true, + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultExtendedInfoResource" + } + } + }, + "deprecated": false, + "x-ms-examples": { + "PATCH ExtendedInfo of Resource": { + "$ref": "./examples/UpdateVaultExtendedInfo.json" + } + } + } + } + }, + "definitions": { + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + } + } + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in customer storage account per hour", + "type": "string" + } + } + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + } + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + } + } + } + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "type": "object", + "properties": { + "value": { + "description": "List of available operationss.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + } + }, + "nextLink": { + "description": "Link to the next chunk of the response", + "type": "string" + } + } + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "ShoeBox properties for the given operation." + } + } + }, + "Resource": { + "description": "ARM Resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "Optional ETag.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "Sku": { + "description": "Identifies the unique system identifier for each Azure resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The Sku name.", + "enum": [ + "Standard", + "RS0" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + } + }, + "TrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties":{ + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PatchTrackedResource": { + "description": "Tracked resource with location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties":{ + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "UpgradeDetails": { + "description": "Details for upgrading vault.", + "type": "object", + "properties": { + "operationId": { + "description": "ID of the vault upgrade operation.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "description": "UTC time at which the upgrade operation has started.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "UTC time at which the upgrade operation status was last updated.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endTimeUtc": { + "description": "UTC time at which the upgrade operation has ended.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "status": { + "description": "Status of the vault upgrade operation.", + "enum": [ + "Unknown", + "InProgress", + "Upgraded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VaultUpgradeState", + "modelAsString": true + } + }, + "message": { + "description": "Message to the user containing information about the upgrade operation.", + "type": "string", + "readOnly": true + }, + "triggerType": { + "description": "The way the vault upgradation was triggered.", + "enum": [ + "UserTriggered", + "ForcedUpgrade" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true + } + }, + "upgradedResourceId": { + "description": "Resource ID of the upgraded vault.", + "type": "string", + "readOnly": true + }, + "previousResourceId": { + "description": "Resource ID of the vault before the upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "Vault": { + "description": "Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "PatchVault": { + "description": "Patch Resource information, as returned by the resource provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PatchTrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "VaultExtendedInfo": { + "description": "Vault extended information.", + "type": "object", + "properties": { + "integrityKey": { + "description": "Integrity key.", + "type": "string" + }, + "encryptionKey": { + "description": "Encryption key.", + "type": "string" + }, + "encryptionKeyThumbprint": { + "description": "Encryption key thumbprint.", + "type": "string" + }, + "algorithm": { + "description": "Algorithm for Vault ExtendedInfo", + "type": "string" + } + } + }, + "VaultExtendedInfoResource": { + "description": "Vault extended information.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VaultExtendedInfo", + "x-ms-client-flatten": true + } + } + }, + "VaultList": { + "description": "The response model for a list of Vaults.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Vault" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "VaultProperties": { + "description": "Properties of the vault.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State.", + "type": "string", + "readOnly": true + }, + "upgradeDetails": { + "$ref": "#/definitions/UpgradeDetails" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json index 7c8ed6657cb6..924beddeba40 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json @@ -1,189 +1,189 @@ -{ - "swagger": "2.0", - "info": { - "version": "2016-06-01", - "title": "RecoveryServicesClient", - "x-ms-code-generation-settings": { - "internalConstructors": false - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages": { - "get": { - "tags": [ - "VaultUsages" - ], - "description": "Fetches the usages of the vault.", - "operationId": "Usages_ListByVaults", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/VaultName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VaultUsageList" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Gets vault usages": { - "$ref": "./examples/ListUsages.json" - } - } - } - } - }, - "definitions": { - "VaultUsage": { - "description": "Usages of a vault.", - "type": "object", - "properties": { - "unit": { - "description": "Unit of the usage.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "Percent", - "CountPerSecond", - "BytesPerSecond" - ], - "type": "string", - "x-ms-enum": { - "name": "UsagesUnit", - "modelAsString": true - } - }, - "quotaPeriod": { - "description": "Quota period of usage.", - "type": "string" - }, - "nextResetTime": { - "format": "date-time", - "description": "Next reset time of usage.", - "type": "string" - }, - "currentValue": { - "format": "int64", - "description": "Current value of usage.", - "type": "integer" - }, - "limit": { - "format": "int64", - "description": "Limit of usage.", - "type": "integer" - }, - "name": { - "$ref": "#/definitions/NameInfo", - "description": "Name of usage." - } - } - }, - "VaultUsageList": { - "description": "Usage for vault.", - "type": "object", - "properties": { - "value": { - "description": "The list of usages for the given vault.", - "type": "array", - "items": { - "$ref": "#/definitions/VaultUsage" - } - } - } - }, - "NameInfo": { - "description": "The name of usage.", - "type": "object", - "properties": { - "value": { - "description": "Value of usage.", - "type": "string" - }, - "localizedValue": { - "description": "Localized value of usage.", - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription Id.", - "required": true, - "type": "string" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group where the recovery services vault is present.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "VaultName": { - "name": "vaultName", - "in": "path", - "description": "The name of the recovery services vault.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account." - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "version": "2016-06-01", + "title": "RecoveryServicesClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages": { + "get": { + "tags": [ + "VaultUsages" + ], + "description": "Fetches the usages of the vault.", + "operationId": "Usages_ListByVaults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultUsageList" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets vault usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + } + }, + "definitions": { + "VaultUsage": { + "description": "Usages of a vault.", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the usage.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "UsagesUnit", + "modelAsString": true + } + }, + "quotaPeriod": { + "description": "Quota period of usage.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time of usage.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value of usage.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "Limit of usage.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/NameInfo", + "description": "Name of usage." + } + } + }, + "VaultUsageList": { + "description": "Usage for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultUsage" + } + } + } + }, + "NameInfo": { + "description": "The name of usage.", + "type": "object", + "properties": { + "value": { + "description": "Value of usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of usage.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json index e30af2a9161a..c677ff2848af 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json @@ -1499,4 +1499,4 @@ } } } - + diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json index 7b004eef0074..fda153ecb9f5 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01" }, diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json index 95fe665a8125..e0bf03027d2b 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json index 65b21d85981b..94b626777fff 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrderDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01", "reservationOrderId": "a075419f-44cc-497f-b68a-14ee811d48b9" diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json index a1929ffb8afa..5b592379574f 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationOrders.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01" }, diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json index 19ee04881381..a5e54e7eb437 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservationRevisions.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json index 0af8dfcdb6b6..e9b8b143be15 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/examples/GetReservations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-06-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da" diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetOperations.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetOperations.json index 6e22f6d908e3..6f7c26704656 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetOperations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01" }, diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationDetails.json index 40f1e2f88b68..8b445066f237 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationDetails.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrderDetails.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrderDetails.json index 4afc13b65cff..f4a4470980e2 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrderDetails.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrderDetails.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01", "reservationOrderId": "a075419f-44cc-497f-b68a-14ee811d48b9" diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrders.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrders.json index 675f1cf25b5f..6deddef7ffcc 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrders.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationOrders.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01" }, diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationRevisions.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationRevisions.json index beac92fe5996..7b9023ebfb90 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationRevisions.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservationRevisions.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservations.json index 81188b6ceff3..ce72bea86f36 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/stable/2017-11-01/examples/GetReservations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2017-11-01", "reservationOrderId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da" diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatus_GetByResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatus_GetByResource.json index 24fe5f963065..60b052266093 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatus_GetByResource.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatus_GetByResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri":"resourceUri", "api-version": "2015-01-01", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListByResourceGroup.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListByResourceGroup.json index 3ec1f7951d4b..6221357b2f26 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListByResourceGroup.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListByResourceGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "resourceGroupName": "resourceGroupName", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListBySubscriptionId.json index 95dac9b6e116..19e278a88d50 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListBySubscriptionId.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_ListBySubscriptionId.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "api-version": "2015-01-01", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json index e601092b4695..2d0a1b8bebbe 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "resourceUri":"resourceUri", "api-version":"2015-01-01" diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatus_GetByResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatus_GetByResource.json index 24fe5f963065..60b052266093 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatus_GetByResource.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatus_GetByResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "resourceUri":"resourceUri", "api-version": "2015-01-01", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListByResourceGroup.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListByResourceGroup.json index 3ec1f7951d4b..6221357b2f26 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListByResourceGroup.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListByResourceGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "resourceGroupName": "resourceGroupName", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListBySubscriptionId.json index 95dac9b6e116..19e278a88d50 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListBySubscriptionId.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_ListBySubscriptionId.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "subscriptionId", "api-version": "2015-01-01", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json index e601092b4695..2d0a1b8bebbe 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "resourceUri":"resourceUri", "api-version":"2015-01-01" diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json index f7d1de97b849..3f0fcac991a8 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertResourceGroupLocation_example.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg1", - "ascLocation": "westeurope", - "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json index bcb4d7fd727d..3f15e4b62461 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertSubscriptionLocation_example.json @@ -1,71 +1,71 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json index ddc50444a3f7..ebc343999c49 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroupLocation_example.json @@ -1,73 +1,73 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg1", - "ascLocation": "westeurope" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json index 415c4dd5a394..117f5d8be81b 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsResourceGroup_example.json @@ -1,72 +1,72 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg1" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json index b1c6da1dce8a..f4f8b014ac5d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscription_example.json @@ -1,150 +1,150 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "systemSource": "Azure", - "vendorName": "Microsoft", - "alertDisplayName": "Suspicious Screensaver process executed", - "alertName": "SuspiciousScreenSaver", - "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", - "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", - "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", - "actionTaken": "Detected", - "reportedSeverity": "Low", - "compromisedEntity": "vm2", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "extendedProperties": { - "domain name": "vm2", - "user name": "vm2\\contosoUser", - "process name": "c:\\users\\contosoUser\\scrsave.scr", - "command line": "c:\\users\\contosoUser\\scrsave.scr", - "parent process": "cmd.exe", - "process id": "0x4aec", - "account logon id": "0x61450d87", - "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", - "parent process id": "0x3c44", - "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", - "resourceType": "Virtual Machine" - }, - "state": "Active", - "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", - "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", - "confidenceScore": 0.3, - "confidenceReasons": [{ - "type": "Process", - "reason": "Suspicious process execution history for this subscription" - }, { - "type": "Process", - "reason": "Suspicious process execution history for this subscription" - }, { - "type": "Process", - "reason": "cmd.exe appeared in multiple alerts of the same type" - }], - "canBeInvestigated": true, - "entities": [{ - "dnsDomain": "", - "ntDomain": "", - "hostName": "vm2", - "netBiosName": "vm2", - "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", - "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", - "operatingSystem": "Unknown", - "type": "host", - "OsVersion": null - }, { - "name": "contosoUser", - "ntDomain": "vm2", - "logonId": "0x61450d87", - "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", - "type": "account" - }, { - "directory": "c:\\windows\\system32", - "name": "cmd.exe", - "type": "file" - }, { - "directory": "c:\\users\\contosoUser", - "name": "scrsave.scr", - "type": "file" - }, { - "processId": "0x4aec", - "commandLine": "c:\\users\\contosoUser\\scrsave.scr", - "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", - "type": "process" - }] - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "systemSource": "Azure", + "vendorName": "Microsoft", + "alertDisplayName": "Suspicious Screensaver process executed", + "alertName": "SuspiciousScreenSaver", + "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", + "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", + "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", + "actionTaken": "Detected", + "reportedSeverity": "Low", + "compromisedEntity": "vm2", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "extendedProperties": { + "domain name": "vm2", + "user name": "vm2\\contosoUser", + "process name": "c:\\users\\contosoUser\\scrsave.scr", + "command line": "c:\\users\\contosoUser\\scrsave.scr", + "parent process": "cmd.exe", + "process id": "0x4aec", + "account logon id": "0x61450d87", + "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", + "parent process id": "0x3c44", + "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", + "resourceType": "Virtual Machine" + }, + "state": "Active", + "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", + "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", + "confidenceScore": 0.3, + "confidenceReasons": [{ + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "cmd.exe appeared in multiple alerts of the same type" + }], + "canBeInvestigated": true, + "entities": [{ + "dnsDomain": "", + "ntDomain": "", + "hostName": "vm2", + "netBiosName": "vm2", + "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", + "operatingSystem": "Unknown", + "type": "host", + "OsVersion": null + }, { + "name": "contosoUser", + "ntDomain": "vm2", + "logonId": "0x61450d87", + "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", + "type": "account" + }, { + "directory": "c:\\windows\\system32", + "name": "cmd.exe", + "type": "file" + }, { + "directory": "c:\\users\\contosoUser", + "name": "scrsave.scr", + "type": "file" + }, { + "processId": "0x4aec", + "commandLine": "c:\\users\\contosoUser\\scrsave.scr", + "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", + "type": "process" + }] + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json index 506adecf7f6e..56f73eba2c63 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/GetAlertsSubscriptionsLocation_example.json @@ -1,154 +1,154 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "vendorName": "Microsoft", - "alertDisplayName": "Threat Intelligence Alert", - "alertName": "ThreatIntelligence", - "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", - "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", - "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", - "actionTaken": "Detected", - "reportedSeverity": "High", - "compromisedEntity": "vm1", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", - "extendedProperties": { - "user Name": "administrator", - "domain Name": "Contoso", - "attacker IP": "192.0.2.1", - "resourceType": "Virtual Machine" - }, - "state": "Dismissed", - "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", - "confidenceScore": 0.8, - "confidenceReasons": [{ - "type": "User", - "reason": "Some user reason" - }, { - "type": "Process", - "reason": "Some proccess reason" - }, { - "type": "Computer", - "reason": "Some computer reason" - }], - "canBeInvestigated": true, - "entities": [{ - "address": "192.0.2.1", - "location": { - "countryCode": "gb", - "state": "wokingham", - "city": "sonning", - "longitude": -0.909, - "latitude": 51.468, - "asn": 6584 - }, - "threatIntelligence": [{ - "providerName": "Team Cymru", - "threatType": "C2", - "threatName": "rarog", - "confidence": 0.8, - "reportLink": "http://www.microsoft.com", - "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." - }], - "type": "ip" - }] - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "type": "Microsoft.Security/Locations/alerts", - "properties": { - "systemSource": "Azure", - "vendorName": "Microsoft", - "alertDisplayName": "Suspicious Screensaver process executed", - "alertName": "SuspiciousScreenSaver", - "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", - "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", - "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", - "actionTaken": "Detected", - "reportedSeverity": "Low", - "compromisedEntity": "vm2", - "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "extendedProperties": { - "domain name": "vm2", - "user name": "vm2\\contosoUser", - "process name": "c:\\users\\contosoUser\\scrsave.scr", - "command line": "c:\\users\\contosoUser\\scrsave.scr", - "parent process": "cmd.exe", - "process id": "0x4aec", - "account logon id": "0x61450d87", - "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", - "parent process id": "0x3c44", - "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", - "resourceType": "Virtual Machine" - }, - "state": "Active", - "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", - "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", - "confidenceScore": 0.3, - "confidenceReasons": [{ - "type": "Process", - "reason": "Suspicious process execution history for this subscription" - }, { - "type": "Process", - "reason": "Suspicious process execution history for this subscription" - }, { - "type": "Process", - "reason": "cmd.exe appeared in multiple alerts of the same type" - }], - "canBeInvestigated": true, - "entities": [{ - "dnsDomain": "", - "ntDomain": "", - "hostName": "vm2", - "netBiosName": "vm2", - "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", - "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", - "operatingSystem": "Unknown", - "type": "host", - "OsVersion": null - }, { - "name": "contosoUser", - "ntDomain": "vm2", - "logonId": "0x61450d87", - "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", - "type": "account" - }, { - "directory": "c:\\windows\\system32", - "name": "cmd.exe", - "type": "file" - }, { - "processId": "0x3c44", - "type": "process" - }, { - "directory": "c:\\users\\contosoUser", - "name": "scrsave.scr", - "type": "file" - }, { - "processId": "0x4aec", - "commandLine": "c:\\users\\contosoUser\\scrsave.scr", - "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", - "type": "process" - }] - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/alerts/2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "name": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "vendorName": "Microsoft", + "alertDisplayName": "Threat Intelligence Alert", + "alertName": "ThreatIntelligence", + "detectedTimeUtc": "2018-05-01T19:50:47.083633Z", + "description": "Process was detected running on the host and is considered to be suspicious, verify that the user run it", + "remediationSteps": "verify that the user invoked this process\r\nrun antimalware scan of the VM", + "actionTaken": "Detected", + "reportedSeverity": "High", + "compromisedEntity": "vm1", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "f144ee95-a3e5-42da-a279-967d115809aa", + "extendedProperties": { + "user Name": "administrator", + "domain Name": "Contoso", + "attacker IP": "192.0.2.1", + "resourceType": "Virtual Machine" + }, + "state": "Dismissed", + "reportedTimeUtc": "2018-05-02T05:36:12.2089889Z", + "confidenceScore": 0.8, + "confidenceReasons": [{ + "type": "User", + "reason": "Some user reason" + }, { + "type": "Process", + "reason": "Some proccess reason" + }, { + "type": "Computer", + "reason": "Some computer reason" + }], + "canBeInvestigated": true, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/westeurope/alerts/2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "name": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "type": "Microsoft.Security/Locations/alerts", + "properties": { + "systemSource": "Azure", + "vendorName": "Microsoft", + "alertDisplayName": "Suspicious Screensaver process executed", + "alertName": "SuspiciousScreenSaver", + "detectedTimeUtc": "2018-05-07T13:51:45.0045913Z", + "description": "The process ‘%{process name}’ was observed executing from an uncommon location.\r\n\r\nFiles with the .scr extensions are screen saver files and are normally reside and execute from the Windows system directory.", + "remediationSteps": "1. Run Process Explorer and try to identify unknown running processes (see https://technet.microsoft.com/en-us/sysinternals/bb896653.aspx)\r\n2. Make sure the machine is completely updated and has an updated anti-malware application installed\r\n3. Run a full anti-malware scan and verify that the threat was removed\r\n4. Install and run Microsoft’s Malicious Software Removal Tool (see https://www.microsoft.com/en-us/download/malicious-software-removal-tool-details.aspx)\r\n5. Run Microsoft’s Autoruns utility and try to identify unknown applications that are configured to run at login (see https://technet.microsoft.com/en-us/sysinternals/bb963902.aspx)\r\n6. Escalate the alert to the information security team", + "actionTaken": "Detected", + "reportedSeverity": "Low", + "compromisedEntity": "vm2", + "associatedResource": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "instanceId": "2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "extendedProperties": { + "domain name": "vm2", + "user name": "vm2\\contosoUser", + "process name": "c:\\users\\contosoUser\\scrsave.scr", + "command line": "c:\\users\\contosoUser\\scrsave.scr", + "parent process": "cmd.exe", + "process id": "0x4aec", + "account logon id": "0x61450d87", + "user SID": "S-1-5-21-2144575486-8928446540-5163864319-500", + "parent process id": "0x3c44", + "enrichment_tas_threat__reports": "{\"Kind\":\"MultiLink\",\"DisplayValueToUrlDictionary\":{\"Report: Suspicious Screen Saver Execution\":\"https://iflowreportsproda.blob.core.windows.net/reports/MSTI-TS-Suspicious-Screen-Saver-Execution.pdf?sv=2016-05-31&sr=b&sig=2igHPl764UM7aBHNaO9mPAnpzoXlwRw8YjpFLLuB2NE%3D&spr=https&st=2018-05-07T00%3A20%3A54Z&se=2018-05-08T00%3A35%3A54Z&sp=r\"}}", + "resourceType": "Virtual Machine" + }, + "state": "Active", + "reportedTimeUtc": "2018-05-07T13:51:48.3810457Z", + "workspaceArmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/microsoft.operationalinsights/workspaces/defaultworkspace-21ff7fc3-e762-48dd-bd96-b551f6dcdd23-weu", + "confidenceScore": 0.3, + "confidenceReasons": [{ + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "Suspicious process execution history for this subscription" + }, { + "type": "Process", + "reason": "cmd.exe appeared in multiple alerts of the same type" + }], + "canBeInvestigated": true, + "entities": [{ + "dnsDomain": "", + "ntDomain": "", + "hostName": "vm2", + "netBiosName": "vm2", + "azureID": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/myRg2/providers/microsoft.compute/virtualmachines/vm2", + "omsAgentID": "45b44640-3b94-4892-a28c-4a5cae27065a", + "operatingSystem": "Unknown", + "type": "host", + "OsVersion": null + }, { + "name": "contosoUser", + "ntDomain": "vm2", + "logonId": "0x61450d87", + "sid": "S-1-5-21-2144575486-8928446540-5163864319-500", + "type": "account" + }, { + "directory": "c:\\windows\\system32", + "name": "cmd.exe", + "type": "file" + }, { + "processId": "0x3c44", + "type": "process" + }, { + "directory": "c:\\users\\contosoUser", + "name": "scrsave.scr", + "type": "file" + }, { + "processId": "0x4aec", + "commandLine": "c:\\users\\contosoUser\\scrsave.scr", + "creationTimeUtc": "2018-05-07T13:51:45.0045913Z", + "type": "process" + }] + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json index e3a50c68d89b..4ff94975fb5f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertResourceGroupLocation_example.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg2", - "ascLocation": "westeurope", - "alertName": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", - "alertUpdateActionType": "Dismiss" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg2", + "ascLocation": "westeurope", + "alertName": "2518765996949954086_2325cf9e-42a2-4f72-ae7f-9b863cba2d22", + "alertUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json index 0debeb1d30fd..cf23c522a362 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Alerts/UpdateAlertSubscriptionLocation_example.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", - "alertUpdateActionType": "Dismiss" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "alertName": "2518770965529163669_F144EE95-A3E5-42DA-A279-967D115809AA", + "alertUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json index 34318bea83e3..2c01f622b339 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg2", - "ascLocation": "centralus", - "discoveredSecuritySolutionName": "paloalto7" - }, - "responses": { - "200": { - "body": { - "properties": { - "securityFamily": "Ngfw", - "offer": "vmseries1", - "publisher": "paloaltonetworks", - "sku": "byol" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", - "name": "paloalto7", - "type": "Microsoft.Security/locations/discoveredSecuritySolutions", - "location": "eastus2" - } - - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg2", + "ascLocation": "centralus", + "discoveredSecuritySolutionName": "paloalto7" + }, + "responses": { + "200": { + "body": { + "properties": { + "securityFamily": "Ngfw", + "offer": "vmseries1", + "publisher": "paloaltonetworks", + "sku": "byol" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", + "name": "paloalto7", + "type": "Microsoft.Security/locations/discoveredSecuritySolutions", + "location": "eastus2" + } + + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json index 7b42e9177837..04b9cb27b648 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "centralus" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "securityFamily": "Ngfw", - "offer": "cisco-asav", - "publisher": "cisco", - "sku": "asav-azure-byol" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP", - "name": "CP", - "type": "Microsoft.Security/locations/discoveredSecuritySolutions", - "location": "eastus" - }, - { - "properties": { - "securityFamily": "Ngfw", - "offer": "vmseries1", - "publisher": "paloaltonetworks", - "sku": "byol" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", - "name": "paloalto7", - "type": "Microsoft.Security/locations/discoveredSecuritySolutions", - "location": "eastus2" - } - ] - } - - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "securityFamily": "Ngfw", + "offer": "cisco-asav", + "publisher": "cisco", + "sku": "asav-azure-byol" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP", + "name": "CP", + "type": "Microsoft.Security/locations/discoveredSecuritySolutions", + "location": "eastus" + }, + { + "properties": { + "securityFamily": "Ngfw", + "offer": "vmseries1", + "publisher": "paloaltonetworks", + "sku": "byol" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", + "name": "paloalto7", + "type": "Microsoft.Security/locations/discoveredSecuritySolutions", + "location": "eastus2" + } + ] + } + + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json index 15a33ccd6826..fa3a836faf41 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json @@ -1,39 +1,39 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "securityFamily": "Ngfw", - "offer": "cisco-asav", - "publisher": "cisco", - "sku": "asav-azure-byol" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP", - "name": "CP", - "type": "Microsoft.Security/locations/discoveredSecuritySolutions", - "location": "eastus" - }, - { - "properties": { - "securityFamily": "Ngfw", - "offer": "vmseries1", - "publisher": "paloaltonetworks", - "sku": "byol" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", - "name": "paloalto7", - "type": "Microsoft.Security/locations/discoveredSecuritySolutions", - "location": "eastus2" - } - ] - } - - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "securityFamily": "Ngfw", + "offer": "cisco-asav", + "publisher": "cisco", + "sku": "asav-azure-byol" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/CP", + "name": "CP", + "type": "Microsoft.Security/locations/discoveredSecuritySolutions", + "location": "eastus" + }, + { + "properties": { + "securityFamily": "Ngfw", + "offer": "vmseries1", + "publisher": "paloaltonetworks", + "sku": "byol" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/discoveredSecuritySolutions/paloalto7", + "name": "paloalto7", + "type": "Microsoft.Security/locations/discoveredSecuritySolutions", + "location": "eastus2" + } + ] + } + + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json index 9d561246553a..b1dde001c258 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "defaultresourcegroup-eus", - "ascLocation": "centralus", - "externalSecuritySolutionsName": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" - }, - "responses": { - "200": { - "body": { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "eastus" - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "defaultresourcegroup-eus", + "ascLocation": "centralus", + "externalSecuritySolutionsName": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" + }, + "responses": { + "200": { + "body": { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "eastus" + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json index 4b828045520f..a7405b5392c1 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json @@ -1,123 +1,123 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "centralus" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "eastus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westeurope" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-09T10:30:11.523Z", - "hostname": "barracuda", - "deviceVendor": "barracudanetworks", - "deviceType": "WAF", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda", - "name": "cef_omsprd_barracudanetworks_waf_barracuda", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-08T15:42:22.57Z", - "hostname": "demovm20", - "deviceVendor": "virtualHoneypot", - "deviceType": "Microsoft", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20", - "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-08T10:38:53.423Z", - "hostname": "demovm10", - "deviceVendor": "virtualHoneypot", - "deviceType": "Microsoft", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10", - "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd", - "name": "aad_omsprd", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "japaneast" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "eastus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westeurope" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-09T10:30:11.523Z", + "hostname": "barracuda", + "deviceVendor": "barracudanetworks", + "deviceType": "WAF", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda", + "name": "cef_omsprd_barracudanetworks_waf_barracuda", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-08T15:42:22.57Z", + "hostname": "demovm20", + "deviceVendor": "virtualHoneypot", + "deviceType": "Microsoft", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20", + "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-08T10:38:53.423Z", + "hostname": "demovm10", + "deviceVendor": "virtualHoneypot", + "deviceType": "Microsoft", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10", + "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd", + "name": "aad_omsprd", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "japaneast" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json index 191fdd390865..fa59f95dd6a9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json @@ -1,122 +1,122 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "eastus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westeurope" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-09T10:30:11.523Z", - "hostname": "barracuda", - "deviceVendor": "barracudanetworks", - "deviceType": "WAF", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda", - "name": "cef_omsprd_barracudanetworks_waf_barracuda", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-08T15:42:22.57Z", - "hostname": "demovm20", - "deviceVendor": "virtualHoneypot", - "deviceType": "Microsoft", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20", - "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "CEF", - "properties": { - "lastEventReceived": "2018-05-08T10:38:53.423Z", - "hostname": "demovm10", - "deviceVendor": "virtualHoneypot", - "deviceType": "Microsoft", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10", - "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd", - "name": "aad_omsprd", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "westcentralus" - }, - { - "kind": "AAD", - "properties": { - "connectivityState": "Discovered", - "deviceVendor": "Microsoft", - "deviceType": "Azure Active Directory Identity Protection", - "workspace": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp" - } - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", - "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", - "type": "Microsoft.Security/locations/externalSecuritySolutions", - "location": "japaneast" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "eastus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-weu/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-weu/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-weu", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westeurope" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-09T10:30:11.523Z", + "hostname": "barracuda", + "deviceVendor": "barracudanetworks", + "deviceType": "WAF", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_barracudanetworks_waf_barracuda", + "name": "cef_omsprd_barracudanetworks_waf_barracuda", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-08T15:42:22.57Z", + "hostname": "demovm20", + "deviceVendor": "virtualHoneypot", + "deviceType": "Microsoft", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm20", + "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm20", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "CEF", + "properties": { + "lastEventReceived": "2018-05-08T10:38:53.423Z", + "hostname": "demovm10", + "deviceVendor": "virtualHoneypot", + "deviceType": "Microsoft", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/cef_omsprd_virtualhoneypot_Microsoft_demovm10", + "name": "cef_omsprd_virtualhoneypot_Microsoft_demovm10", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/unificationprod/providers/Microsoft.OperationalInsights/workspaces/omsprd" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/unificationprod/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_omsprd", + "name": "aad_omsprd", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "westcentralus" + }, + { + "kind": "AAD", + "properties": { + "connectivityState": "Discovered", + "deviceVendor": "Microsoft", + "deviceType": "Azure Active Directory Identity Protection", + "workspace": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-ejp/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp" + } + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-ejp/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", + "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-ejp", + "type": "Microsoft.Security/locations/externalSecuritySolutions", + "location": "japaneast" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json index 691a6fbea2c0..865c26da5cf9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json @@ -1,93 +1,93 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1", - "jitNetworkAccessPolicyName": "default", - "body":{ - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - } - }, - "responses": { - "200": { - "body": { - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "body":{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + }, + "responses": { + "200": { + "body": { + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json index a6486af030fc..06a2fe92aa72 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json @@ -1,15 +1,15 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1", - "jitNetworkAccessPolicyName": "default" - }, - "responses": { - "200": { - }, - "204": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default" + }, + "responses": { + "200": { + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json index 1f52d31d67fc..98bfc6898349 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json @@ -1,54 +1,54 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1" - }, - "responses": { - "200": { - "body": { - "value": [{ - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json index de24bcd2f463..9d46ba25fdb7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg1" - }, - "responses": { - "200": { - "body": { - "value": [{ - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json index bec7fd1da349..051aa4e18891 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope" - }, - "responses": { - "200": { - "body": { - "value": [{ - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json index 968d48bf8c25..c87956a907b9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json index 56f9a543528b..ea716b630370 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json @@ -1,53 +1,53 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1", - "jitNetworkAccessPolicyName": "default" - }, - "responses": { - "200": { - "body": { - "kind": "Basic", - "properties": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 22, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - }, - { - "number": 3389, - "protocol": "*", - "allowedSourceAddressPrefix": "*", - "maxRequestAccessDuration": "PT3H" - } - ] - }], - "requests": [{ - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-05-17T09:06:45.5691611Z", - "status": "Initiated", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-05-17T08:06:45.5691611Z", - "requestor": "barbara@contoso.com" - }], - "provisioningState": "Succeeded" - }, - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", - "name": "default", - "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", - "location": "westeurope" - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default" + }, + "responses": { + "200": { + "body": { + "kind": "Basic", + "properties": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 22, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + }, + { + "number": 3389, + "protocol": "*", + "allowedSourceAddressPrefix": "*", + "maxRequestAccessDuration": "PT3H" + } + ] + }], + "requests": [{ + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-05-17T09:06:45.5691611Z", + "status": "Initiated", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-05-17T08:06:45.5691611Z", + "requestor": "barbara@contoso.com" + }], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/westeurope/jitNetworkAccessPolicies/default", + "name": "default", + "type": "Microsoft.Security/locations/jitNetworkAccessPolicies", + "location": "westeurope" + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json index f234178e85be..9d970331e6a9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json @@ -1,38 +1,38 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1", - "jitNetworkAccessPolicyName": "default", - "jitNetworkAccessPolicyInitiateType": "initiate", - "body": { - "virtualMachines": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "duration": "PT1H", - "allowedSourceAddressPrefix": "192.127.0.2" - }] - }] - } - }, - "responses": { - "202": { - "body": { - "virtualMachines": [{ - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [{ - "number": 3389, - "allowedSourceAddressPrefix": "192.127.0.2", - "endTimeUtc": "2018-07-12T09:53:03.3658798Z", - "status": "Initiating", - "statusReason": "UserRequested" - }] - }], - "startTimeUtc": "2018-07-12T08:53:03.3658798Z", - "requestor": "barbara@contoso.com" - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "jitNetworkAccessPolicyInitiateType": "initiate", + "body": { + "virtualMachines": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "duration": "PT1H", + "allowedSourceAddressPrefix": "192.127.0.2" + }] + }] + } + }, + "responses": { + "202": { + "body": { + "virtualMachines": [{ + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [{ + "number": 3389, + "allowedSourceAddressPrefix": "192.127.0.2", + "endTimeUtc": "2018-07-12T09:53:03.3658798Z", + "status": "Initiating", + "statusReason": "UserRequested" + }] + }], + "startTimeUtc": "2018-07-12T08:53:03.3658798Z", + "requestor": "barbara@contoso.com" + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json index 95e378b7cb31..580b514a8211 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/JitNetworkAccessPolicies/InvokeJitNetworkAccessPolicy_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg1", - "jitNetworkAccessPolicyName": "default", - "jitNetworkAccessPolicyActionType": "initiate", - "body": { - "virtualMachines": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", - "ports": [ - { - "number": 3389, - "duration": "PT1H", - "allowedSourceAddressPrefix": "192.127.0.2" - } - ] - } - ] - } - }, - "responses": { - "202": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg1", + "jitNetworkAccessPolicyName": "default", + "jitNetworkAccessPolicyActionType": "initiate", + "body": { + "virtualMachines": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Compute/virtualMachines/vm1", + "ports": [ + { + "number": 3389, + "duration": "PT1H", + "allowedSourceAddressPrefix": "192.127.0.2" + } + ] + } + ] + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json index 97c210917a96..33afce562bd0 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocation_example.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "centralus" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", - "name": "centralus", - "type": "Microsoft.Security/locations", - "properties": { - "homeRegionName": "centralus" - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", + "name": "centralus", + "type": "Microsoft.Security/locations", + "properties": { + "homeRegionName": "centralus" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json index d5ffd8738b01..1525e1649377 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Locations/GetLocations_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", - "name": "centralus", - "type": "Microsoft.Security/locations", - "properties": { - "homeRegionName": "centralus" - } - }] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus", + "name": "centralus", + "type": "Microsoft.Security/locations", + "properties": { + "homeRegionName": "centralus" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json index 3fcc10920cdc..2458dd524285 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskResourceGroupLocation_example.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg", - "ascLocation": "westeurope", - "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", - "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", - "securityTaskParameters": { - "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "vmName": "vm1", - "severity": "High", - "isOsDiskEncrypted": false, - "isDataDiskEncrypted": false, - "name": "EncryptionOnVm", - "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" - } - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "ascLocation": "westeurope", + "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json index cdc93f875de2..e3bb9c0fa2b5 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTaskSubscriptionLocation_example.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", - "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", - "securityTaskParameters": { - "resourceName": "default", - "resourceType": "Subnet", - "resourceParent": "vnet1", - "location": "uksouth", - "resourceGroup": "myRg", - "name": "NetworkSecurityGroupMissingOnSubnet", - "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" - } - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json index 3dd4b1f07640..060bd0ff0b85 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json @@ -1,37 +1,37 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg", - "ascLocation": "westeurope" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", - "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", - "securityTaskParameters": { - "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "vmName": "vm1", - "severity": "High", - "isOsDiskEncrypted": false, - "isDataDiskEncrypted": false, - "name": "EncryptionOnVm", - "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" - } - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json index f7b50de923fd..1c919e8baf2f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscriptionLocation_example.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", - "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", - "securityTaskParameters": { - "resourceName": "default", - "resourceType": "Subnet", - "resourceParent": "vnet1", - "location": "uksouth", - "resourceGroup": "myRg", - "name": "NetworkSecurityGroupMissingOnSubnet", - "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" - } - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", - "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", - "securityTaskParameters": { - "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "vmName": "vm1", - "severity": "High", - "isOsDiskEncrypted": false, - "isDataDiskEncrypted": false, - "name": "EncryptionOnVm", - "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" - } - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json index ed5e2100f33d..e2547ab81bbc 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksSubscription_example.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", - "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", - "securityTaskParameters": { - "resourceName": "default", - "resourceType": "Subnet", - "resourceParent": "vnet1", - "location": "uksouth", - "resourceGroup": "myRg", - "name": "NetworkSecurityGroupMissingOnSubnet", - "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" - } - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "type": "Microsoft.Security/locations/tasks", - "properties": { - "state": "Active", - "subState": "NA", - "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", - "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", - "securityTaskParameters": { - "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "vmName": "vm1", - "severity": "High", - "isOsDiskEncrypted": false, - "isDataDiskEncrypted": false, - "name": "EncryptionOnVm", - "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", - "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" - } - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westeurope/tasks/62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "name": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-03-05T10:42:03.9935508Z", + "lastStateChangeTimeUtc": "2018-03-05T10:42:03.9935508Z", + "securityTaskParameters": { + "resourceName": "default", + "resourceType": "Subnet", + "resourceParent": "vnet1", + "location": "uksouth", + "resourceGroup": "myRg", + "name": "NetworkSecurityGroupMissingOnSubnet", + "uniqueKey": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/default" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "type": "Microsoft.Security/locations/tasks", + "properties": { + "state": "Active", + "subState": "NA", + "creationTimeUtc": "2018-04-02T11:41:27.0541014Z", + "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z", + "securityTaskParameters": { + "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "vmName": "vm1", + "severity": "High", + "isOsDiskEncrypted": false, + "isDataDiskEncrypted": false, + "name": "EncryptionOnVm", + "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json index 4008f6de1d33..aa441126d1a3 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskResourceGroupLocation_example.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "resourceGroupName": "myRg", - "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", - "taskUpdateActionType": "Dismiss" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "resourceGroupName": "myRg", + "taskName": "d55b4dc0-779c-c66c-33e5-d7bce24c4222", + "taskUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json index 0b72f9904b58..0be932e8e9f2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/UpdateTaskSubscriptionLocation_example.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "ascLocation": "westeurope", - "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", - "taskUpdateActionType": "Dismiss" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westeurope", + "taskName": "62609ee7-d0a5-8616-9fe4-1df5cca7758d", + "taskUpdateActionType": "Dismiss" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json index 393f66b40116..9b5a0b813ce4 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json @@ -1,2679 +1,2679 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2015-06-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": { - "/providers/Microsoft.Security/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Exposes all available operations for discovery purposes.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations": { - "get": { - "x-ms-examples": { - "Get security data locations": { - "$ref": "./examples/Locations/GetLocations_example.json" - } - }, - "tags": [ - "Locations" - ], - "description": "The location of the responsible ASC of the specific subscription (home region). For each subscription there is only one responsible location. The location in the response should be used to read or write other resources in ASC according to their ID.", - "operationId": "Locations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AscLocationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}": { - "get": { - "x-ms-examples": { - "Get security data location": { - "$ref": "./examples/Locations/GetLocation_example.json" - } - }, - "tags": [ - "Locations" - ], - "description": "Details of a specific location", - "operationId": "Locations_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AscLocation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/tasks": { - "get": { - "x-ms-examples": { - "Get security recommendations tasks": { - "$ref": "./examples/Tasks/GetTasksSubscription_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { - "get": { - "x-ms-examples": { - "Get security recommendations tasks from security data location": { - "$ref": "./examples/Tasks/GetTasksSubscriptionLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_ListByHomeRegion", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { - "get": { - "x-ms-examples": { - "Get security recommendation task from security data location": { - "$ref": "./examples/Tasks/GetTaskSubscriptionLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_GetSubscriptionLevelTask", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTask" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { - "post": { - "x-ms-examples": { - "Change security recommendation task state": { - "$ref": "./examples/Tasks/UpdateTaskSubscriptionLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_UpdateSubscriptionLevelTaskState", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - }, - { - "$ref": "#/parameters/TaskUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { - "get": { - "x-ms-examples": { - "Get security recommendation tasks in a resource group": { - "$ref": "./examples/Tasks/GetTasksResourceGroupLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { - "get": { - "x-ms-examples": { - "Get security recommendation task in a resource group": { - "$ref": "./examples/Tasks/GetTaskResourceGroupLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_GetResourceGroupLevelTask", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTask" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { - "post": { - "x-ms-examples": { - "Change security recommendation task state": { - "$ref": "./examples/Tasks/UpdateTaskResourceGroupLocation_example.json" - } - }, - "tags": [ - "Tasks" - ], - "description": "Recommended tasks that will help improve the security of the subscription proactively", - "operationId": "Tasks_UpdateResourceGroupLevelTaskState", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - }, - { - "$ref": "#/parameters/TaskUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/alerts": { - "get": { - "x-ms-examples": { - "Get security alerts on a subscription": { - "$ref": "./examples/Alerts/GetAlertsSubscription_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "List all the alerts that are associated with the subscription", - "operationId": "Alerts_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataSelect" - }, - { - "$ref": "#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/alerts": { - "get": { - "x-ms-examples": { - "Get security alerts on a resource group": { - "$ref": "./examples/Alerts/GetAlertsResourceGroup_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "List all the alerts alerts that are associated with the resource group", - "operationId": "Alerts_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataSelect" - }, - { - "$ref": "#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { - "get": { - "x-ms-examples": { - "Get security alerts on a subscription from a security data location": { - "$ref": "./examples/Alerts/GetAlertsSubscriptionsLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "List all the alerts that are associated with the subscription that are stored in a specific location", - "operationId": "Alerts_ListSubscriptionLevelAlertsByRegion", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataSelect" - }, - { - "$ref": "#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { - "get": { - "x-ms-examples": { - "Get security alerts on a resource group from a security data location": { - "$ref": "./examples/Alerts/GetAlertsResourceGroupLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "List all the alerts that are associated with the resource group that are stored in a specific location", - "operationId": "Alerts_ListResourceGroupLevelAlertsByRegion", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/ODataFilter" - }, - { - "$ref": "#/parameters/ODataSelect" - }, - { - "$ref": "#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { - "get": { - "x-ms-examples": { - "Get security alert on a subscription from a security data location": { - "$ref": "./examples/Alerts/GetAlertSubscriptionLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Get an alert that is associated with a subscription", - "operationId": "Alerts_GetSubscriptionLevelAlert", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { - "get": { - "x-ms-examples": { - "Get security alert on a resource group from a security data location": { - "$ref": "./examples/Alerts/GetAlertResourceGroupLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Get an alert that is associated a resource group or a resource in a resource group", - "operationId": "Alerts_GetResourceGroupLevelAlerts", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "#/parameters/ResourceGroupName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { - "post": { - "x-ms-examples": { - "Update security alert state on a subscription from a security data location": { - "$ref": "./examples/Alerts/UpdateAlertSubscriptionLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Update the alert's state", - "operationId": "Alerts_UpdateSubscriptionLevelAlertState", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "#/parameters/AlertUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { - "post": { - "x-ms-examples": { - "Update security alert state on a resource group from a security data location": { - "$ref": "./examples/Alerts/UpdateAlertResourceGroupLocation_example.json" - } - }, - "tags": [ - "Alerts" - ], - "description": "Update the alert's state", - "operationId": "Alerts_UpdateResourceGroupLevelAlertState", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "#/parameters/AlertUpdateActionType" - }, - { - "$ref": "#/parameters/ResourceGroupName" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/discoveredSecuritySolutions": { - "get": { - "x-ms-examples": { - "Get discovered security solutions": { - "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json" - } - }, - "tags": [ - "DiscoveredSecuritySolutions" - ], - "description": "Gets a list of discovered Security Solutions for the subscription.", - "operationId": "DiscoveredSecuritySolutions_List", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions": { - "get": { - "x-ms-examples": { - "Get discovered security solutions from a security data location": { - "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json" - } - }, - "tags": [ - "DiscoveredSecuritySolutions" - ], - "description": "Gets a list of discovered Security Solutions for the subscription and location.", - "operationId": "DiscoveredSecuritySolutions_ListByHomeRegion", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions/{discoveredSecuritySolutionName}": { - "get": { - "x-ms-examples": { - "Get discovered security solution from a security data location": { - "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json" - } - }, - "tags": [ - "DiscoveredSecuritySolutions" - ], - "description": "Gets a specific discovered Security Solution.", - "operationId": "DiscoveredSecuritySolutions_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/DiscoveredSecuritySolutionName" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolution" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/jitNetworkAccessPolicies": { - "get": { - "x-ms-examples": { - "Get JIT network access policies on a subscription": { - "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Policies for protecting resources using Just-in-Time access control.", - "operationId": "JitNetworkAccessPolicies_List", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { - "get": { - "x-ms-examples": { - "Get JIT network access policies on a subscription from a security data location": { - "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", - "operationId": "JitNetworkAccessPolicies_ListByRegion", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/jitNetworkAccessPolicies": { - "get": { - "x-ms-examples": { - "Get JIT network access policies on a resource group": { - "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", - "operationId": "JitNetworkAccessPolicies_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { - "get": { - "x-ms-examples": { - "Get JIT network access policies on a resource group from a security data location": { - "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", - "operationId": "JitNetworkAccessPolicies_ListByResourceGroupAndRegion", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}": { - "get": { - "x-ms-examples": { - "Get JIT network access policy": { - "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", - "operationId": "JitNetworkAccessPolicies_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create JIT network access policy": { - "$ref": "./examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Create a policy for protecting resources using Just-in-Time access control", - "operationId": "JitNetworkAccessPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicy" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a JIT network access policy": { - "$ref": "./examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Delete a Just-in-Time access control policy.", - "operationId": "JitNetworkAccessPolicies_Delete", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK - Resource was deleted" - }, - "204": { - "description": "No Content - Resource does not exist" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}/{jitNetworkAccessPolicyInitiateType}": { - "post": { - "x-ms-examples": { - "Initiate an action on a JIT network access policy": { - "$ref": "./examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json" - } - }, - "tags": [ - "JitNetworkAccessPolicies" - ], - "description": "Initiate a JIT access from a specific Just-in-Time policy configuration.", - "operationId": "JitNetworkAccessPolicies_Initiate", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyInitiateType" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyInitiateRequest" - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/JitNetworkAccessRequest" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/externalSecuritySolutions": { - "get": { - "x-ms-examples": { - "Get external security solutions on a subscription": { - "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json" - } - }, - "description": "Gets a list of external security solutions for the subscription.", - "tags": [ - "ExternalSecuritySolutions" - ], - "operationId": "ExternalSecuritySolutions_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions": { - "get": { - "x-ms-examples": { - "Get external security solutions on a subscription from security data location": { - "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json" - } - }, - "description": "Gets a list of external Security Solutions for the subscription and location.", - "tags": [ - "ExternalSecuritySolutions" - ], - "operationId": "ExternalSecuritySolutions_ListByHomeRegion", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName}": { - "get": { - "x-ms-examples": { - "Get external security solution": { - "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json" - } - }, - "description": "Gets a specific external Security Solution.", - "tags": [ - "ExternalSecuritySolutions" - ], - "operationId": "ExternalSecuritySolutions_Get", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ExternalSecuritySolutionsName" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolution" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "CloudError": { - "x-ms-external": true, - "type": "object", - "description": "Error response structure.", - "properties": { - "error": { - "x-ms-client-flatten": true, - "description": "Error data", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "CloudErrorBody": { - "x-ms-external": true, - "type": "object", - "description": "Error details.", - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "readOnly": true, - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - } - } - }, - "Resource": { - "type": "object", - "description": "Describes an Azure resource.", - "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" - } - }, - "x-ms-azure-resource": true - }, - "Kind": { - "type": "object", - "description": "Describes an Azure resource with kind", - "properties": { - "kind": { - "type": "string", - "description": "Kind of the resource" - } - } - }, - "Location": { - "type": "object", - "description": "Describes an Azure resource with location", - "properties": { - "location": { - "readOnly": true, - "type": "string", - "description": "Location where the resource is stored" - } - } - }, - "OperationList": { - "type": "object", - "description": "List of possible operations for Microsoft.Security resource provider", - "properties": { - "value": { - "type": "array", - "description": "List of Security operations", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "Operation": { - "type": "object", - "description": "Possible operation in the REST API of Microsoft.Security", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the operation" - }, - "origin": { - "readOnly": true, - "type": "string", - "description": "Where the operation is originated" - }, - "display": { - "$ref": "#/definitions/OperationDisplay" - } - } - }, - "OperationDisplay": { - "type": "object", - "description": "Security operation display", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "The resource provider for the operation." - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "The display name of the resource the operation applies to." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "The display name of the security operation." - }, - "description": { - "readOnly": true, - "type": "string", - "description": "The description of the operation." - } - } - }, - "SecurityTaskList": { - "type": "object", - "description": "List of security task recommendations", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/SecurityTask" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "SecurityTask": { - "type": "object", - "description": "Security task that we recommend to do in order to strengthen security", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SecurityTaskProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "SecurityTaskProperties": { - "type": "object", - "description": "Describes properties of a task.", - "properties": { - "state": { - "readOnly": true, - "type": "string", - "description": "State of the task (Active, Resolved etc.)" - }, - "creationTimeUtc": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time this task was discovered in UTC" - }, - "securityTaskParameters": { - "$ref": "#/definitions/SecurityTaskParameters" - }, - "lastStateChangeTimeUtc": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time this task's details were last changed in UTC" - }, - "subState": { - "readOnly": true, - "type": "string", - "description": "Additional data on the state of the task" - } - } - }, - "SecurityTaskParameters": { - "type": "object", - "description": "Changing set of properties, depending on the task type that is derived from the name field", - "additionalProperties": { - "type": "object" - }, - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the task type" - } - } - }, - "AscLocationList": { - "type": "object", - "description": "List of locations where ASC saves your data", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/AscLocation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "AscLocation": { - "type": "object", - "description": "The ASC location of the subscription is in the \"name\" field", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AscLocationProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "AscLocationProperties": { - "type": "object", - "description": "An empty set of properties" - }, - "AlertList": { - "type": "object", - "description": "List of security alerts", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Alert" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "Alert": { - "type": "object", - "description": "Security alert", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AlertProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "AlertProperties": { - "type": "object", - "description": "describes security alert properties.", - "properties": { - "state": { - "readOnly": true, - "type": "string", - "description": "State of the alert (Active, Dismissed etc.)" - }, - "reportedTimeUtc": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time the incident was reported to Microsoft.Security in UTC" - }, - "vendorName": { - "readOnly": true, - "type": "string", - "description": "Name of the vendor that discovered the incident" - }, - "alertName": { - "readOnly": true, - "type": "string", - "description": "Name of the alert type" - }, - "alertDisplayName": { - "readOnly": true, - "type": "string", - "description": "Display name of the alert type" - }, - "detectedTimeUtc": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The time the incident was detected by the vendor" - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Description of the incident and what it means" - }, - "remediationSteps": { - "readOnly": true, - "type": "string", - "description": "Recommended steps to reradiate the incident" - }, - "actionTaken": { - "readOnly": true, - "type": "string", - "description": "The action that was taken as a response to the alert (Active, Blocked etc.)" - }, - "reportedSeverity": { - "readOnly": true, - "type": "string", - "description": "Estimated severity of this alert" - }, - "compromisedEntity": { - "readOnly": true, - "type": "string", - "description": "The entity that the incident happened on" - }, - "associatedResource": { - "readOnly": true, - "type": "string", - "description": "Azure resource ID of the associated resource" - }, - "extendedProperties": { - "$ref": "#/definitions/AlertExtendedProperties" - }, - "systemSource": { - "readOnly": true, - "type": "string", - "description": "The type of the alerted resource (Azure, Non-Azure)" - }, - "canBeInvestigated": { - "readOnly": true, - "type": "boolean", - "description": "Whether this alert can be investigated with Azure Security Center" - }, - "entities": { - "type": "array", - "description": "objects that are related to this alerts", - "items": { - "$ref": "#/definitions/AlertEntity" - } - }, - "confidenceScore": { - "readOnly": true, - "type": "number", - "format": "float", - "minimum": 0, - "maximum": 1, - "description": "level of confidence we have on the alert" - }, - "confidenceReasons": { - "type": "array", - "description": "reasons the alert got the confidenceScore value", - "items": { - "$ref": "#/definitions/AlertConfidenceReason" - } - }, - "subscriptionId": { - "readOnly": true, - "type": "string", - "description": "Azure subscription ID of the resource that had the security alert or the subscription ID of the workspace that this resource reports to" - }, - "instanceId": { - "readOnly": true, - "type": "string", - "description": "Instance ID of the alert." - }, - "workspaceArmId": { - "readOnly": true, - "type": "string", - "description": "Azure resource ID of the workspace that the alert was reported to." - } - } - }, - "AlertConfidenceReason": { - "type": "object", - "description": "Factors that increase our confidence that the alert is a true positive", - "properties": { - "type": { - "readOnly": true, - "type": "string", - "description": "Type of confidence factor" - }, - "reason": { - "readOnly": true, - "type": "string", - "description": "description of the confidence reason" - } - } - }, - "AlertEntity": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "Changing set of properties depending on the entity type.", - "properties": { - "type": { - "readOnly": true, - "type": "string", - "description": "Type of entity" - } - } - }, - "AlertExtendedProperties": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "Changing set of properties depending on the alert type." - }, - "DiscoveredSecuritySolutionList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DiscoveredSecuritySolution" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "DiscoveredSecuritySolution": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DiscoveredSecuritySolutionProperties" - } - }, - "required": [ - "properties" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/Location" - } - ] - }, - "DiscoveredSecuritySolutionProperties": { - "type": "object", - "properties": { - "securityFamily": { - "type": "string", - "description": "The security family of the discovered solution", - "enum": [ - "Waf", - "Ngfw", - "SaasWaf", - "Va" - ], - "x-ms-enum": { - "name": "securityFamily", - "modelAsString": true, - "values": [ - { - "value": "Waf" - }, - { - "value": "Ngfw" - }, - { - "value": "SaasWaf" - }, - { - "value": "Va" - } - ] - } - }, - "offer": { - "type": "string", - "description": "The security solutions' image offer" - }, - "publisher": { - "type": "string", - "description": "The security solutions' image publisher" - }, - "sku": { - "type": "string", - "description": "The security solutions' image sku" - } - }, - "required": [ - "securityFamily", - "offer", - "publisher", - "sku" - ] - }, - "JitNetworkAccessPoliciesList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "JitNetworkAccessPolicy": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/JitNetworkAccessPolicyProperties" - } - }, - "required": [ - "properties" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/Kind" - }, - { - "$ref": "#/definitions/Location" - } - ] - }, - "JitNetworkAccessPolicyProperties": { - "type": "object", - "properties": { - "virtualMachines": { - "type": "array", - "description": "Configurations for Microsoft.Compute/virtualMachines resource type.", - "items": { - "$ref": "#/definitions/JitNetworkAccessPolicyVirtualMachine" - } - }, - "requests": { - "type": "array", - "items": { - "$ref": "#/definitions/JitNetworkAccessRequest" - } - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Gets the provisioning state of the Just-in-Time policy." - } - }, - "required": [ - "virtualMachines" - ] - }, - "JitNetworkAccessPolicyVirtualMachine": { - "type": "object", - "required": [ - "id", - "ports" - ], - "properties": { - "id": { - "type": "string", - "description": "Resource ID of the virtual machine that is linked to this policy" - }, - "ports": { - "type": "array", - "description": "Port configurations for the virtual machine", - "items": { - "$ref": "#/definitions/JitNetworkAccessPortRule" - } - } - } - }, - "JitNetworkAccessPortRule": { - "type": "object", - "properties": { - "number": { - "$ref": "#/definitions/PortNumber" - }, - "protocol": { - "type": "string", - "enum": [ - "TCP", - "UDP", - "*" - ], - "x-ms-enum": { - "name": "protocol", - "modelAsString": true, - "values": [ - { - "value": "TCP" - }, - { - "value": "UDP" - }, - { - "value": "*", - "name": "All" - } - ] - } - }, - "allowedSourceAddressPrefix": { - "type": "string", - "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." - }, - "allowedSourceAddressPrefixes": { - "type": "array", - "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", - "items": { - "type": "string", - "description": "IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." - } - }, - "maxRequestAccessDuration": { - "type": "string", - "description": "Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day" - } - }, - "required": [ - "maxRequestAccessDuration", - "number", - "protocol" - ] - }, - "JitNetworkAccessRequest": { - "type": "object", - "properties": { - "virtualMachines": { - "type": "array", - "items": { - "$ref": "#/definitions/JitNetworkAccessRequestVirtualMachine" - } - }, - "startTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The start time of the request in UTC" - }, - "requestor": { - "type": "string", - "description": "The identity of the person who made the request" - } - }, - "required": [ - "requestor", - "startTimeUtc", - "virtualMachines" - ] - }, - "JitNetworkAccessRequestVirtualMachine": { - "type": "object", - "required": [ - "id", - "ports" - ], - "properties": { - "id": { - "type": "string", - "description": "Resource ID of the virtual machine that is linked to this policy" - }, - "ports": { - "type": "array", - "description": "The ports that were opened for the virtual machine", - "items": { - "$ref": "#/definitions/JitNetworkAccessRequestPort" - } - } - } - }, - "JitNetworkAccessRequestPort": { - "type": "object", - "properties": { - "number": { - "$ref": "#/definitions/PortNumber" - }, - "allowedSourceAddressPrefix": { - "type": "string", - "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." - }, - "allowedSourceAddressPrefixes": { - "type": "array", - "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", - "items": { - "description": "IP addess or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\".", - "type": "string" - } - }, - "endTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The date & time at which the request ends in UTC" - }, - "status": { - "type": "string", - "description": "The status of the port", - "enum": [ - "Revoked", - "Initiated" - ], - "x-ms-enum": { - "name": "status", - "modelAsString": true, - "values": [ - { - "value": "Revoked" - }, - { - "value": "Initiated" - } - ] - } - }, - "statusReason": { - "type": "string", - "description": "A description of why the `status` has its value", - "enum": [ - "Expired", - "UserRequested", - "NewerRequestInitiated" - ], - "x-ms-enum": { - "name": "statusReason", - "modelAsString": true, - "values": [ - { - "value": "Expired" - }, - { - "value": "UserRequested" - }, - { - "value": "NewerRequestInitiated" - } - ] - } - } - }, - "required": [ - "endTimeUtc", - "number", - "status", - "statusReason" - ] - }, - "JitNetworkAccessPolicyInitiateRequest": { - "type": "object", - "properties": { - "virtualMachines": { - "type": "array", - "description": "A list of virtual machines & ports to open access for", - "items": { - "$ref": "#/definitions/JitNetworkAccessPolicyInitiateVirtualMachine" - } - } - }, - "required": [ - "virtualMachines" - ] - }, - "JitNetworkAccessPolicyInitiateVirtualMachine": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID of the virtual machine that is linked to this policy" - }, - "ports": { - "type": "array", - "description": "The ports to open for the resource with the `id`", - "items": { - "$ref": "#/definitions/JitNetworkAccessPolicyInitiatePort" - } - } - }, - "required": [ - "id", - "ports" - ] - }, - "JitNetworkAccessPolicyInitiatePort": { - "type": "object", - "properties": { - "number": { - "$ref": "#/definitions/PortNumber" - }, - "allowedSourceAddressPrefix": { - "type": "string", - "description": "Source of the allowed traffic. If omitted, the request will be for the source IP address of the initiate request." - }, - "endTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The time to close the request in UTC" - } - }, - "required": [ - "endTimeUtc", - "number" - ] - }, - "PortNumber": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "ExternalSecuritySolutionList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ExternalSecuritySolution" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "ExternalSecuritySolution": { - "type": "object", - "description": "Represents a security solution external to Azure Security Center which sends information to an OMS workspace and whos data is displayed by Azure Security Center.", - "discriminator": "kind", - "properties": {}, - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/ExternalSecuritySolutionKind" - }, - { - "$ref": "#/definitions/Location" - } - ] - }, - "CefExternalSecuritySolution": { - "x-ms-discriminator-value": "CEF", - "type": "object", - "description": "Represents a security solution which sends CEF logs to an OMS workspace", - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolution" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/CefSolutionProperties" - } - } - }, - "AtaExternalSecuritySolution": { - "x-ms-discriminator-value": "ATA", - "type": "object", - "description": "Represents an ATA security solution which sends logs to an OMS workspace", - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolution" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AtaSolutionProperties" - } - } - }, - "AadExternalSecuritySolution": { - "x-ms-discriminator-value": "AAD", - "type": "object", - "description": "Represents an AAD identity protection solution which sends logs to an OMS workspace.", - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolution" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AadSolutionProperties" - } - } - }, - "ExternalSecuritySolutionKind": { - "type": "object", - "description": "Describes an Azure resource with kind", - "properties": { - "kind": { - "type": "string", - "description": "The kind of the external solution", - "enum": [ - "CEF", - "ATA", - "AAD" - ], - "x-ms-enum": { - "name": "ExternalSecuritySolutionKind", - "modelAsString": true, - "values": [ - { - "value": "CEF" - }, - { - "value": "ATA" - }, - { - "value": "AAD" - } - ] - } - } - } - }, - "ExternalSecuritySolutionProperties": { - "type": "object", - "description": "The solution properties (correspond to the solution kind)", - "additionalProperties": true, - "properties": { - "deviceVendor": { - "type": "string" - }, - "deviceType": { - "type": "string" - }, - "workspace": { - "$ref": "#/definitions/ConnectedWorkspace" - } - } - }, - "ConnectedWorkspace": { - "type": "object", - "title": "Represents an OMS workspace to which the solution is connected", - "properties": { - "id": { - "type": "string", - "description": "Azure resource ID of the connected OMS workspace" - } - } - }, - "AadConnectivityState": { - "type": "object", - "description": "Describes an Azure resource with kind", - "properties": { - "connectivityState": { - "type": "string", - "title": "The connectivity state of the external AAD solution ", - "enum": [ - "Discovered", - "NotLicensed", - "Connected" - ], - "x-ms-enum": { - "name": "AadConnectivityState", - "modelAsString": true, - "values": [ - { - "value": "Discovered" - }, - { - "value": "NotLicensed" - }, - { - "value": "Connected" - } - ] - } - } - } - }, - "AadSolutionProperties": { - "type": "object", - "title": "The external security solution properties for AAD solutions", - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolutionProperties" - }, - { - "$ref": "#/definitions/AadConnectivityState" - } - ] - }, - "CefSolutionProperties": { - "type": "object", - "title": "The external security solution properties for CEF solutions", - "properties": { - "hostname": { - "type": "string" - }, - "agent": { - "type": "string" - }, - "lastEventReceived": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolutionProperties" - } - ] - }, - "AtaSolutionProperties": { - "type": "object", - "title": "The external security solution properties for ATA solutions", - "properties": { - "lastEventReceived": { - "type": "string" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ExternalSecuritySolutionProperties" - } - ] - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", - "type": "string", - "description": "Azure subscription ID" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "2015-06-01-preview" - ], - "description": "API version for the operation" - }, - "AscLocation": { - "name": "ascLocation", - "in": "path", - "required": true, - "type": "string", - "description": "The location where ASC stores the data of the subscription. can be retrieved from Get locations", - "x-ms-parameter-location": "client" - }, - "ExtendedResourceProvider": { - "name": "extendedResourceProvider", - "in": "path", - "required": true, - "type": "string", - "description": "Resource provider name of the base resource", - "x-ms-parameter-location": "method" - }, - "ExtendedResourceType": { - "name": "extendedResourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Type of the base resource", - "x-ms-parameter-location": "method" - }, - "ExtendedResourceName": { - "name": "extendedResourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the base resource", - "x-ms-parameter-location": "method" - }, - "ODataFilter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter. Optional.", - "x-ms-parameter-location": "method" - }, - "ODataSelect": { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "OData select. Optional.", - "x-ms-parameter-location": "method" - }, - "ODataExpand": { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expand. Optional.", - "x-ms-parameter-location": "method" - }, - "TaskName": { - "name": "taskName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the task object, will be a GUID", - "x-ms-parameter-location": "method" - }, - "TaskUpdateActionType": { - "name": "taskUpdateActionType", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "Activate", - "Dismiss", - "Start", - "Resolve", - "Close" - ], - "description": "Type of the action to do on the task", - "x-ms-parameter-location": "method" - }, - "AlertName": { - "name": "alertName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the alert object", - "x-ms-parameter-location": "method" - }, - "AlertUpdateActionType": { - "name": "alertUpdateActionType", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "Dismiss", - "Reactivate" - ], - "description": "Type of the action to do on the alert", - "x-ms-parameter-location": "method" - }, - "DiscoveredSecuritySolutionName": { - "name": "discoveredSecuritySolutionName", - "type": "string", - "in": "path", - "required": true, - "description": "Name of a discovered security solution.", - "x-ms-parameter-location": "method" - }, - "JitNetworkAccessPolicyName": { - "name": "jitNetworkAccessPolicyName", - "type": "string", - "in": "path", - "required": true, - "description": "Name of a Just-in-Time access configuration policy.", - "x-ms-parameter-location": "method" - }, - "JitNetworkAccessPolicyInitiateType": { - "name": "jitNetworkAccessPolicyInitiateType", - "type": "string", - "in": "path", - "required": true, - "description": "Type of the action to do on the Just-in-Time access policy.", - "enum": [ - "initiate" - ], - "x-ms-parameter-location": "method" - }, - "JitNetworkAccessPolicyInitiateRequest": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicyInitiateRequest" - }, - "x-ms-parameter-location": "method" - }, - "JitNetworkAccessPolicy": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - }, - "x-ms-parameter-location": "method" - }, - "ExternalSecuritySolutionsName": { - "name": "externalSecuritySolutionsName", - "in": "path", - "description": "Name of an external security solution.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2015-06-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": { + "/providers/Microsoft.Security/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Exposes all available operations for discovery purposes.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations": { + "get": { + "x-ms-examples": { + "Get security data locations": { + "$ref": "./examples/Locations/GetLocations_example.json" + } + }, + "tags": [ + "Locations" + ], + "description": "The location of the responsible ASC of the specific subscription (home region). For each subscription there is only one responsible location. The location in the response should be used to read or write other resources in ASC according to their ID.", + "operationId": "Locations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AscLocationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}": { + "get": { + "x-ms-examples": { + "Get security data location": { + "$ref": "./examples/Locations/GetLocation_example.json" + } + }, + "tags": [ + "Locations" + ], + "description": "Details of a specific location", + "operationId": "Locations_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AscLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendations tasks": { + "$ref": "./examples/Tasks/GetTasksSubscription_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendations tasks from security data location": { + "$ref": "./examples/Tasks/GetTasksSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_ListByHomeRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { + "get": { + "x-ms-examples": { + "Get security recommendation task from security data location": { + "$ref": "./examples/Tasks/GetTaskSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_GetSubscriptionLevelTask", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { + "post": { + "x-ms-examples": { + "Change security recommendation task state": { + "$ref": "./examples/Tasks/UpdateTaskSubscriptionLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_UpdateSubscriptionLevelTaskState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks": { + "get": { + "x-ms-examples": { + "Get security recommendation tasks in a resource group": { + "$ref": "./examples/Tasks/GetTasksResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}": { + "get": { + "x-ms-examples": { + "Get security recommendation task in a resource group": { + "$ref": "./examples/Tasks/GetTaskResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_GetResourceGroupLevelTask", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks/{taskName}/{taskUpdateActionType}": { + "post": { + "x-ms-examples": { + "Change security recommendation task state": { + "$ref": "./examples/Tasks/UpdateTaskResourceGroupLocation_example.json" + } + }, + "tags": [ + "Tasks" + ], + "description": "Recommended tasks that will help improve the security of the subscription proactively", + "operationId": "Tasks_UpdateResourceGroupLevelTaskState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a subscription": { + "$ref": "./examples/Alerts/GetAlertsSubscription_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the subscription", + "operationId": "Alerts_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a resource group": { + "$ref": "./examples/Alerts/GetAlertsResourceGroup_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts alerts that are associated with the resource group", + "operationId": "Alerts_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a subscription from a security data location": { + "$ref": "./examples/Alerts/GetAlertsSubscriptionsLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the subscription that are stored in a specific location", + "operationId": "Alerts_ListSubscriptionLevelAlertsByRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts": { + "get": { + "x-ms-examples": { + "Get security alerts on a resource group from a security data location": { + "$ref": "./examples/Alerts/GetAlertsResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "List all the alerts that are associated with the resource group that are stored in a specific location", + "operationId": "Alerts_ListResourceGroupLevelAlertsByRegion", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataSelect" + }, + { + "$ref": "#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { + "get": { + "x-ms-examples": { + "Get security alert on a subscription from a security data location": { + "$ref": "./examples/Alerts/GetAlertSubscriptionLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Get an alert that is associated with a subscription", + "operationId": "Alerts_GetSubscriptionLevelAlert", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}": { + "get": { + "x-ms-examples": { + "Get security alert on a resource group from a security data location": { + "$ref": "./examples/Alerts/GetAlertResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Get an alert that is associated a resource group or a resource in a resource group", + "operationId": "Alerts_GetResourceGroupLevelAlerts", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { + "post": { + "x-ms-examples": { + "Update security alert state on a subscription from a security data location": { + "$ref": "./examples/Alerts/UpdateAlertSubscriptionLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Update the alert's state", + "operationId": "Alerts_UpdateSubscriptionLevelAlertState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/alerts/{alertName}/{alertUpdateActionType}": { + "post": { + "x-ms-examples": { + "Update security alert state on a resource group from a security data location": { + "$ref": "./examples/Alerts/UpdateAlertResourceGroupLocation_example.json" + } + }, + "tags": [ + "Alerts" + ], + "description": "Update the alert's state", + "operationId": "Alerts_UpdateResourceGroupLevelAlertState", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/discoveredSecuritySolutions": { + "get": { + "x-ms-examples": { + "Get discovered security solutions": { + "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscription_example.json" + } + }, + "tags": [ + "DiscoveredSecuritySolutions" + ], + "description": "Gets a list of discovered Security Solutions for the subscription.", + "operationId": "DiscoveredSecuritySolutions_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions": { + "get": { + "x-ms-examples": { + "Get discovered security solutions from a security data location": { + "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionsSubscriptionLocation_example.json" + } + }, + "tags": [ + "DiscoveredSecuritySolutions" + ], + "description": "Gets a list of discovered Security Solutions for the subscription and location.", + "operationId": "DiscoveredSecuritySolutions_ListByHomeRegion", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/discoveredSecuritySolutions/{discoveredSecuritySolutionName}": { + "get": { + "x-ms-examples": { + "Get discovered security solution from a security data location": { + "$ref": "./examples/DiscoveredSecuritySolutions/GetDiscoveredSecuritySolutionResourceGroupLocation_example.json" + } + }, + "tags": [ + "DiscoveredSecuritySolutions" + ], + "description": "Gets a specific discovered Security Solution.", + "operationId": "DiscoveredSecuritySolutions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/DiscoveredSecuritySolutionName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a subscription": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscription_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control.", + "operationId": "JitNetworkAccessPolicies_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a subscription from a security data location": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesSubscriptionLocation_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByRegion", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a resource group": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroup_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies": { + "get": { + "x-ms-examples": { + "Get JIT network access policies on a resource group from a security data location": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPoliciesResourceGroupLocation_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_ListByResourceGroupAndRegion", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}": { + "get": { + "x-ms-examples": { + "Get JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/GetJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Policies for protecting resources using Just-in-Time access control for the subscription, location", + "operationId": "JitNetworkAccessPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/CreateJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Create a policy for protecting resources using Just-in-Time access control", + "operationId": "JitNetworkAccessPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicy" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/DeleteJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Delete a Just-in-Time access control policy.", + "operationId": "JitNetworkAccessPolicies_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK - Resource was deleted" + }, + "204": { + "description": "No Content - Resource does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/jitNetworkAccessPolicies/{jitNetworkAccessPolicyName}/{jitNetworkAccessPolicyInitiateType}": { + "post": { + "x-ms-examples": { + "Initiate an action on a JIT network access policy": { + "$ref": "./examples/JitNetworkAccessPolicies/InitiateJitNetworkAccessPolicy_example.json" + } + }, + "tags": [ + "JitNetworkAccessPolicies" + ], + "description": "Initiate a JIT access from a specific Just-in-Time policy configuration.", + "operationId": "JitNetworkAccessPolicies_Initiate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateType" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateRequest" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/JitNetworkAccessRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/externalSecuritySolutions": { + "get": { + "x-ms-examples": { + "Get external security solutions on a subscription": { + "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscription_example.json" + } + }, + "description": "Gets a list of external security solutions for the subscription.", + "tags": [ + "ExternalSecuritySolutions" + ], + "operationId": "ExternalSecuritySolutions_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions": { + "get": { + "x-ms-examples": { + "Get external security solutions on a subscription from security data location": { + "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolutionsSubscriptionLocation_example.json" + } + }, + "description": "Gets a list of external Security Solutions for the subscription and location.", + "tags": [ + "ExternalSecuritySolutions" + ], + "operationId": "ExternalSecuritySolutions_ListByHomeRegion", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName}": { + "get": { + "x-ms-examples": { + "Get external security solution": { + "$ref": "./examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json" + } + }, + "description": "Gets a specific external Security Solution.", + "tags": [ + "ExternalSecuritySolutions" + ], + "operationId": "ExternalSecuritySolutions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ExternalSecuritySolutionsName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "type": "object", + "description": "Error response structure.", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + } + }, + "Resource": { + "type": "object", + "description": "Describes an Azure resource.", + "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" + } + }, + "x-ms-azure-resource": true + }, + "Kind": { + "type": "object", + "description": "Describes an Azure resource with kind", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the resource" + } + } + }, + "Location": { + "type": "object", + "description": "Describes an Azure resource with location", + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location where the resource is stored" + } + } + }, + "OperationList": { + "type": "object", + "description": "List of possible operations for Microsoft.Security resource provider", + "properties": { + "value": { + "type": "array", + "description": "List of Security operations", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Operation": { + "type": "object", + "description": "Possible operation in the REST API of Microsoft.Security", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Where the operation is originated" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "type": "object", + "description": "Security operation display", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "The resource provider for the operation." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "The display name of the resource the operation applies to." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The display name of the security operation." + }, + "description": { + "readOnly": true, + "type": "string", + "description": "The description of the operation." + } + } + }, + "SecurityTaskList": { + "type": "object", + "description": "List of security task recommendations", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SecurityTask" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "SecurityTask": { + "type": "object", + "description": "Security task that we recommend to do in order to strengthen security", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityTaskProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "SecurityTaskProperties": { + "type": "object", + "description": "Describes properties of a task.", + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "State of the task (Active, Resolved etc.)" + }, + "creationTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time this task was discovered in UTC" + }, + "securityTaskParameters": { + "$ref": "#/definitions/SecurityTaskParameters" + }, + "lastStateChangeTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time this task's details were last changed in UTC" + }, + "subState": { + "readOnly": true, + "type": "string", + "description": "Additional data on the state of the task" + } + } + }, + "SecurityTaskParameters": { + "type": "object", + "description": "Changing set of properties, depending on the task type that is derived from the name field", + "additionalProperties": { + "type": "object" + }, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the task type" + } + } + }, + "AscLocationList": { + "type": "object", + "description": "List of locations where ASC saves your data", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AscLocation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AscLocation": { + "type": "object", + "description": "The ASC location of the subscription is in the \"name\" field", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AscLocationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "AscLocationProperties": { + "type": "object", + "description": "An empty set of properties" + }, + "AlertList": { + "type": "object", + "description": "List of security alerts", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Alert": { + "type": "object", + "description": "Security alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "AlertProperties": { + "type": "object", + "description": "describes security alert properties.", + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "State of the alert (Active, Dismissed etc.)" + }, + "reportedTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the incident was reported to Microsoft.Security in UTC" + }, + "vendorName": { + "readOnly": true, + "type": "string", + "description": "Name of the vendor that discovered the incident" + }, + "alertName": { + "readOnly": true, + "type": "string", + "description": "Name of the alert type" + }, + "alertDisplayName": { + "readOnly": true, + "type": "string", + "description": "Display name of the alert type" + }, + "detectedTimeUtc": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the incident was detected by the vendor" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the incident and what it means" + }, + "remediationSteps": { + "readOnly": true, + "type": "string", + "description": "Recommended steps to reradiate the incident" + }, + "actionTaken": { + "readOnly": true, + "type": "string", + "description": "The action that was taken as a response to the alert (Active, Blocked etc.)" + }, + "reportedSeverity": { + "readOnly": true, + "type": "string", + "description": "Estimated severity of this alert" + }, + "compromisedEntity": { + "readOnly": true, + "type": "string", + "description": "The entity that the incident happened on" + }, + "associatedResource": { + "readOnly": true, + "type": "string", + "description": "Azure resource ID of the associated resource" + }, + "extendedProperties": { + "$ref": "#/definitions/AlertExtendedProperties" + }, + "systemSource": { + "readOnly": true, + "type": "string", + "description": "The type of the alerted resource (Azure, Non-Azure)" + }, + "canBeInvestigated": { + "readOnly": true, + "type": "boolean", + "description": "Whether this alert can be investigated with Azure Security Center" + }, + "entities": { + "type": "array", + "description": "objects that are related to this alerts", + "items": { + "$ref": "#/definitions/AlertEntity" + } + }, + "confidenceScore": { + "readOnly": true, + "type": "number", + "format": "float", + "minimum": 0, + "maximum": 1, + "description": "level of confidence we have on the alert" + }, + "confidenceReasons": { + "type": "array", + "description": "reasons the alert got the confidenceScore value", + "items": { + "$ref": "#/definitions/AlertConfidenceReason" + } + }, + "subscriptionId": { + "readOnly": true, + "type": "string", + "description": "Azure subscription ID of the resource that had the security alert or the subscription ID of the workspace that this resource reports to" + }, + "instanceId": { + "readOnly": true, + "type": "string", + "description": "Instance ID of the alert." + }, + "workspaceArmId": { + "readOnly": true, + "type": "string", + "description": "Azure resource ID of the workspace that the alert was reported to." + } + } + }, + "AlertConfidenceReason": { + "type": "object", + "description": "Factors that increase our confidence that the alert is a true positive", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of confidence factor" + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "description of the confidence reason" + } + } + }, + "AlertEntity": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Changing set of properties depending on the entity type.", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of entity" + } + } + }, + "AlertExtendedProperties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "Changing set of properties depending on the alert type." + }, + "DiscoveredSecuritySolutionList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiscoveredSecuritySolution" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "DiscoveredSecuritySolution": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiscoveredSecuritySolutionProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/Location" + } + ] + }, + "DiscoveredSecuritySolutionProperties": { + "type": "object", + "properties": { + "securityFamily": { + "type": "string", + "description": "The security family of the discovered solution", + "enum": [ + "Waf", + "Ngfw", + "SaasWaf", + "Va" + ], + "x-ms-enum": { + "name": "securityFamily", + "modelAsString": true, + "values": [ + { + "value": "Waf" + }, + { + "value": "Ngfw" + }, + { + "value": "SaasWaf" + }, + { + "value": "Va" + } + ] + } + }, + "offer": { + "type": "string", + "description": "The security solutions' image offer" + }, + "publisher": { + "type": "string", + "description": "The security solutions' image publisher" + }, + "sku": { + "type": "string", + "description": "The security solutions' image sku" + } + }, + "required": [ + "securityFamily", + "offer", + "publisher", + "sku" + ] + }, + "JitNetworkAccessPoliciesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "JitNetworkAccessPolicy": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/JitNetworkAccessPolicyProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/Kind" + }, + { + "$ref": "#/definitions/Location" + } + ] + }, + "JitNetworkAccessPolicyProperties": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "description": "Configurations for Microsoft.Compute/virtualMachines resource type.", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyVirtualMachine" + } + }, + "requests": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequest" + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Gets the provisioning state of the Just-in-Time policy." + } + }, + "required": [ + "virtualMachines" + ] + }, + "JitNetworkAccessPolicyVirtualMachine": { + "type": "object", + "required": [ + "id", + "ports" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "Port configurations for the virtual machine", + "items": { + "$ref": "#/definitions/JitNetworkAccessPortRule" + } + } + } + }, + "JitNetworkAccessPortRule": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "*" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP" + }, + { + "value": "UDP" + }, + { + "value": "*", + "name": "All" + } + ] + } + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + }, + "allowedSourceAddressPrefixes": { + "type": "array", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", + "items": { + "type": "string", + "description": "IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + } + }, + "maxRequestAccessDuration": { + "type": "string", + "description": "Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day" + } + }, + "required": [ + "maxRequestAccessDuration", + "number", + "protocol" + ] + }, + "JitNetworkAccessRequest": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequestVirtualMachine" + } + }, + "startTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The start time of the request in UTC" + }, + "requestor": { + "type": "string", + "description": "The identity of the person who made the request" + } + }, + "required": [ + "requestor", + "startTimeUtc", + "virtualMachines" + ] + }, + "JitNetworkAccessRequestVirtualMachine": { + "type": "object", + "required": [ + "id", + "ports" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "The ports that were opened for the virtual machine", + "items": { + "$ref": "#/definitions/JitNetworkAccessRequestPort" + } + } + } + }, + "JitNetworkAccessRequestPort": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefixes\" parameter. Should be an IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\"." + }, + "allowedSourceAddressPrefixes": { + "type": "array", + "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", + "items": { + "description": "IP addess or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\".", + "type": "string" + } + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The date & time at which the request ends in UTC" + }, + "status": { + "type": "string", + "description": "The status of the port", + "enum": [ + "Revoked", + "Initiated" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true, + "values": [ + { + "value": "Revoked" + }, + { + "value": "Initiated" + } + ] + } + }, + "statusReason": { + "type": "string", + "description": "A description of why the `status` has its value", + "enum": [ + "Expired", + "UserRequested", + "NewerRequestInitiated" + ], + "x-ms-enum": { + "name": "statusReason", + "modelAsString": true, + "values": [ + { + "value": "Expired" + }, + { + "value": "UserRequested" + }, + { + "value": "NewerRequestInitiated" + } + ] + } + } + }, + "required": [ + "endTimeUtc", + "number", + "status", + "statusReason" + ] + }, + "JitNetworkAccessPolicyInitiateRequest": { + "type": "object", + "properties": { + "virtualMachines": { + "type": "array", + "description": "A list of virtual machines & ports to open access for", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiateVirtualMachine" + } + } + }, + "required": [ + "virtualMachines" + ] + }, + "JitNetworkAccessPolicyInitiateVirtualMachine": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of the virtual machine that is linked to this policy" + }, + "ports": { + "type": "array", + "description": "The ports to open for the resource with the `id`", + "items": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiatePort" + } + } + }, + "required": [ + "id", + "ports" + ] + }, + "JitNetworkAccessPolicyInitiatePort": { + "type": "object", + "properties": { + "number": { + "$ref": "#/definitions/PortNumber" + }, + "allowedSourceAddressPrefix": { + "type": "string", + "description": "Source of the allowed traffic. If omitted, the request will be for the source IP address of the initiate request." + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The time to close the request in UTC" + } + }, + "required": [ + "endTimeUtc", + "number" + ] + }, + "PortNumber": { + "type": "integer", + "minimum": 0, + "maximum": 65535 + }, + "ExternalSecuritySolutionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExternalSecuritySolution" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "ExternalSecuritySolution": { + "type": "object", + "description": "Represents a security solution external to Azure Security Center which sends information to an OMS workspace and whos data is displayed by Azure Security Center.", + "discriminator": "kind", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ExternalSecuritySolutionKind" + }, + { + "$ref": "#/definitions/Location" + } + ] + }, + "CefExternalSecuritySolution": { + "x-ms-discriminator-value": "CEF", + "type": "object", + "description": "Represents a security solution which sends CEF logs to an OMS workspace", + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolution" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CefSolutionProperties" + } + } + }, + "AtaExternalSecuritySolution": { + "x-ms-discriminator-value": "ATA", + "type": "object", + "description": "Represents an ATA security solution which sends logs to an OMS workspace", + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolution" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AtaSolutionProperties" + } + } + }, + "AadExternalSecuritySolution": { + "x-ms-discriminator-value": "AAD", + "type": "object", + "description": "Represents an AAD identity protection solution which sends logs to an OMS workspace.", + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolution" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AadSolutionProperties" + } + } + }, + "ExternalSecuritySolutionKind": { + "type": "object", + "description": "Describes an Azure resource with kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the external solution", + "enum": [ + "CEF", + "ATA", + "AAD" + ], + "x-ms-enum": { + "name": "ExternalSecuritySolutionKind", + "modelAsString": true, + "values": [ + { + "value": "CEF" + }, + { + "value": "ATA" + }, + { + "value": "AAD" + } + ] + } + } + } + }, + "ExternalSecuritySolutionProperties": { + "type": "object", + "description": "The solution properties (correspond to the solution kind)", + "additionalProperties": true, + "properties": { + "deviceVendor": { + "type": "string" + }, + "deviceType": { + "type": "string" + }, + "workspace": { + "$ref": "#/definitions/ConnectedWorkspace" + } + } + }, + "ConnectedWorkspace": { + "type": "object", + "title": "Represents an OMS workspace to which the solution is connected", + "properties": { + "id": { + "type": "string", + "description": "Azure resource ID of the connected OMS workspace" + } + } + }, + "AadConnectivityState": { + "type": "object", + "description": "Describes an Azure resource with kind", + "properties": { + "connectivityState": { + "type": "string", + "title": "The connectivity state of the external AAD solution ", + "enum": [ + "Discovered", + "NotLicensed", + "Connected" + ], + "x-ms-enum": { + "name": "AadConnectivityState", + "modelAsString": true, + "values": [ + { + "value": "Discovered" + }, + { + "value": "NotLicensed" + }, + { + "value": "Connected" + } + ] + } + } + } + }, + "AadSolutionProperties": { + "type": "object", + "title": "The external security solution properties for AAD solutions", + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolutionProperties" + }, + { + "$ref": "#/definitions/AadConnectivityState" + } + ] + }, + "CefSolutionProperties": { + "type": "object", + "title": "The external security solution properties for CEF solutions", + "properties": { + "hostname": { + "type": "string" + }, + "agent": { + "type": "string" + }, + "lastEventReceived": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolutionProperties" + } + ] + }, + "AtaSolutionProperties": { + "type": "object", + "title": "The external security solution properties for ATA solutions", + "properties": { + "lastEventReceived": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ExternalSecuritySolutionProperties" + } + ] + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "type": "string", + "description": "Azure subscription ID" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2015-06-01-preview" + ], + "description": "API version for the operation" + }, + "AscLocation": { + "name": "ascLocation", + "in": "path", + "required": true, + "type": "string", + "description": "The location where ASC stores the data of the subscription. can be retrieved from Get locations", + "x-ms-parameter-location": "client" + }, + "ExtendedResourceProvider": { + "name": "extendedResourceProvider", + "in": "path", + "required": true, + "type": "string", + "description": "Resource provider name of the base resource", + "x-ms-parameter-location": "method" + }, + "ExtendedResourceType": { + "name": "extendedResourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Type of the base resource", + "x-ms-parameter-location": "method" + }, + "ExtendedResourceName": { + "name": "extendedResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the base resource", + "x-ms-parameter-location": "method" + }, + "ODataFilter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional.", + "x-ms-parameter-location": "method" + }, + "ODataSelect": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData select. Optional.", + "x-ms-parameter-location": "method" + }, + "ODataExpand": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "OData expand. Optional.", + "x-ms-parameter-location": "method" + }, + "TaskName": { + "name": "taskName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the task object, will be a GUID", + "x-ms-parameter-location": "method" + }, + "TaskUpdateActionType": { + "name": "taskUpdateActionType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Activate", + "Dismiss", + "Start", + "Resolve", + "Close" + ], + "description": "Type of the action to do on the task", + "x-ms-parameter-location": "method" + }, + "AlertName": { + "name": "alertName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the alert object", + "x-ms-parameter-location": "method" + }, + "AlertUpdateActionType": { + "name": "alertUpdateActionType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Dismiss", + "Reactivate" + ], + "description": "Type of the action to do on the alert", + "x-ms-parameter-location": "method" + }, + "DiscoveredSecuritySolutionName": { + "name": "discoveredSecuritySolutionName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of a discovered security solution.", + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyName": { + "name": "jitNetworkAccessPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of a Just-in-Time access configuration policy.", + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyInitiateType": { + "name": "jitNetworkAccessPolicyInitiateType", + "type": "string", + "in": "path", + "required": true, + "description": "Type of the action to do on the Just-in-Time access policy.", + "enum": [ + "initiate" + ], + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicyInitiateRequest": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicyInitiateRequest" + }, + "x-ms-parameter-location": "method" + }, + "JitNetworkAccessPolicy": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + }, + "x-ms-parameter-location": "method" + }, + "ExternalSecuritySolutionsName": { + "name": "externalSecuritySolutionsName", + "in": "path", + "description": "Name of an external security solution.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json index 507975c379e2..57fb3300bb60 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "settingName": "default", - "setting": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", - "name": "default", - "type": "Microsoft.Security/autoProvisioningSettings", - "properties": { - "autoProvision": "On" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", - "name": "default", - "type": "Microsoft.Security/autoProvisioningSettings", - "properties": { - "autoProvision": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "default", + "setting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json index 6ff9bb0e7264..2b095698851a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "settingName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", - "name": "default", - "type": "Microsoft.Security/autoProvisioningSettings", - "properties": { - "autoProvision": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json index 1574e0bfb25c..4f2838d7e6e2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", - "name": "default", - "type": "Microsoft.Security/autoProvisioningSettings", - "properties": { - "autoProvision": "On" - } - }] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default", + "name": "default", + "type": "Microsoft.Security/autoProvisioningSettings", + "properties": { + "autoProvision": "On" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json index 13282477404d..668297cb44ef 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "complianceName": "2018-01-01Z" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", - "name": "2018-01-01Z", - "type": "Microsoft.Security/compliances", - "properties": { - "assessmentResult": [ - { - "segmentType": "Compliant", - "percentage": 77.77777777777778 - } - ], - "resourceCount": 18, - "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "complianceName": "2018-01-01Z" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", + "name": "2018-01-01Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 77.77777777777778 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json index 572e5dfd150d..1337c71c42e2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", - "name": "2018-01-01Z", - "type": "Microsoft.Security/compliances", - "properties": { - "assessmentResult": [ - { - "segmentType": "Compliant", - "percentage": 77.77777777777778 - } - ], - "resourceCount": 18, - "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z", - "name": "2018-01-02Z", - "type": "Microsoft.Security/compliances", - "properties": { - "assessmentResult": [ - { - "segmentType": "Compliant", - "percentage": 94.44444444444444 - } - ], - "resourceCount": 18, - "assessmentTimestampUtcDate": "2018-01-02T00:00:00Z" - } - - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z", - "name": "2018-01-03Z", - "type": "Microsoft.Security/compliances", - "properties": { - "assessmentResult": [ - { - "segmentType": "Compliant", - "percentage": 100 - } - ], - "resourceCount": 18, - "assessmentTimestampUtcDate": "2018-01-03T00:00:00Z" - } - - } - ] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z", + "name": "2018-01-01Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 77.77777777777778 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-01T00:00:00Z" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z", + "name": "2018-01-02Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 94.44444444444444 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-02T00:00:00Z" + } + + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z", + "name": "2018-01-03Z", + "type": "Microsoft.Security/compliances", + "properties": { + "assessmentResult": [ + { + "segmentType": "Compliant", + "percentage": 100 + } + ], + "resourceCount": 18, + "assessmentTimestampUtcDate": "2018-01-03T00:00:00Z" + } + + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json index 4c6f9559b08c..e59560bc370e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsResourceGroup_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg", - "pricingName": "myRg", - "pricing": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/pricings/myRg", - "name": "myRg", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", - "name": "myRg", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "pricingName": "myRg", + "pricing": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json index 015885fc5779..220052e0447c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/CreatePricingsSubscription_example.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "pricingName": "default", - "pricing": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", - "name": "default", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", - "name": "default", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "default", + "pricing": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json index f261d4fdacad..2a10c1b3bae4 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingResourceGroup_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg", - "pricingName": "myRg" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", - "name": "myRg", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg", + "pricingName": "myRg" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json index 03457284b7a9..9113f59599c7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingSubscription_example.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "pricingName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", - "name": "default", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json index 26fe2c08bcbd..e439e08cbff5 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsResourceGroup_example.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "myRg" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", - "name": "myRg", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - }] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/myRg", + "name": "myRg", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json index d32cc7e34516..5a88b41a641a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Pricings/GetPricingsSubscription_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", - "name": "default", - "type": "Microsoft.Security/pricings", - "properties": { - "pricingTier": "Standard" - } - }] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/default", + "name": "default", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json index 9deda54049f1..8ff996c3bbe1 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john", - "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "john@contoso.com", - "phone": "(214)275-4038", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "john@contoso.com", - "phone": "(214)275-4038", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json index 948df8317165..7adb8e5ff04f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json index fcc0762de7c6..4b387554703d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "john@contoso.com", - "phone": "(214)275-4038", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json index 514a72a545d1..07eca33d66dd 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "john@contoso.com", - "phone": "(214)275-4038", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - }] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json index 1de75b59b395..bb6a660dcce2 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john", - "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "phone": "(214)275-4038", - "alertNotifications": "On" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "john@contoso.com", - "phone": "(214)275-4038", - "alertNotifications": "On", - "alertsToAdmins": "Off" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "john", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "phone": "(214)275-4038", + "alertNotifications": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", + "name": "john", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "john@contoso.com", + "phone": "(214)275-4038", + "alertNotifications": "On", + "alertsToAdmins": "Off" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSetting_example.json index c7dd9545eb40..d400edf86c57 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSetting_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "settingName": "MCAS" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", - "name": "MCAS", - "kind": "DataExportSetting", - "type": "Microsoft.Security/settings", - "properties": { - "enabled": true - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSetting", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSettings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSettings_example.json index a3be78de6a2b..acf22eeb4e3b 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSettings_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSettings_example.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", - "name": "MCAS", - "kind": "DataExportSetting", - "type": "Microsoft.Security/settings", - "properties": { - "enabled": true - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP", - "name": "WDATP", - "kind": "DataExportSetting", - "type": "Microsoft.Security/settings", - "properties": { - "enabled": false - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSetting", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP", + "name": "WDATP", + "kind": "DataExportSetting", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": false + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/UpdateSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/UpdateSetting_example.json index a6494654cb18..17c046d4d999 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/UpdateSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/UpdateSetting_example.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "settingName": "MCAS", - "setting": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", - "name": "MCAS", - "kind": "DataExportSetting", - "type": "Microsoft.Security/settings", - "properties": { - "enabled": true - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", - "name": "MCAS", - "kind": "DataExportSetting", - "type": "Microsoft.Security/settings", - "properties": { - "enabled": true - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "settingName": "MCAS", + "setting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSetting", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS", + "name": "MCAS", + "kind": "DataExportSetting", + "type": "Microsoft.Security/settings", + "properties": { + "enabled": true + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json index 93f50607489c..f9ecc62a9965 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/CreateWorkspaceSetting_example.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "workspaceSettingName": "default", - "workspaceSetting": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default", + "workspaceSetting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json index e1446e820d88..9bb7be67b739 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json @@ -1,11 +1,11 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "workspaceSettingName": "default" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default" + }, + "responses": { + "204": { + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json index 5f9db230473b..705d85293349 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSetting_example.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "workspaceSettingName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json index b27d8bf1b0f0..d4b23e39d093 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/GetWorkspaceSettings_example.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/workspaceSettings/myRg", - "name": "myRg", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myOtherRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace2", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg" - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/workspaceSettings/myRg", + "name": "myRg", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myOtherRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace2", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json index 78a09a611098..e4e7078f84cd 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "workspaceSettingName": "default", - "workspaceSetting": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", - "name": "default", - "type": "Microsoft.Security/workspaceSettings", - "properties": { - "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", - "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "workspaceSettingName": "default", + "workspaceSetting": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/workspaceSettings/default", + "name": "default", + "type": "Microsoft.Security/workspaceSettings", + "properties": { + "workspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace", + "scope": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json index 58bc707fcfe7..38cc96c4485e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json @@ -1,1474 +1,1474 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2017-08-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.Security/pricings": { - "get": { - "x-ms-examples": { - "Get pricings on subscription": { - "$ref": "./examples/Pricings/GetPricingsSubscription_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configurations in the subscription", - "operationId": "Pricings_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PricingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings": { - "get": { - "x-ms-examples": { - "Get pricings on subscription": { - "$ref": "./examples/Pricings/GetPricingsResourceGroup_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configurations in the resource group", - "operationId": "Pricings_ListByResourceGroup", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/ResourceGroupName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PricingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}": { - "get": { - "x-ms-examples": { - "Get pricings on subscription": { - "$ref": "./examples/Pricings/GetPricingSubscription_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configuration in the subscriptionSecurity pricing configuration in the subscription", - "operationId": "Pricings_GetSubscriptionPricing", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/PricingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Update pricings on subscription": { - "$ref": "./examples/Pricings/CreatePricingsSubscription_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configuration in the subscription", - "operationId": "Pricings_UpdateSubscriptionPricing", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/PricingName" - }, { - "$ref": "#/parameters/Pricing" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings/{pricingName}": { - "get": { - "x-ms-examples": { - "Get pricings on subscription": { - "$ref": "./examples/Pricings/GetPricingResourceGroup_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configuration in the resource group", - "operationId": "Pricings_GetResourceGroupPricing", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/ResourceGroupName" - }, { - "$ref": "#/parameters/PricingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Update pricings on resource group": { - "$ref": "./examples/Pricings/CreatePricingsResourceGroup_example.json" - } - }, - "tags": ["Pricings"], - "description": "Security pricing configuration in the resource group", - "operationId": "Pricings_CreateOrUpdateResourceGroupPricing", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/ResourceGroupName" - }, { - "$ref": "#/parameters/PricingName" - }, { - "$ref": "#/parameters/Pricing" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts": { - "get": { - "x-ms-examples": { - "Update security contact data": { - "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { - "get": { - "x-ms-examples": { - "Get security contact data": { - "$ref": "./examples/SecurityContacts/GetSecurityContact_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Get", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create security contact data": { - "$ref": "./examples/SecurityContacts/CreateSecurityContact_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Create", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }, { - "$ref": "#/parameters/SecurityContact" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete security contact data": { - "$ref": "./examples/SecurityContacts/DeleteSecurityContact_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Delete", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "x-ms-examples": { - "Update security contact data": { - "$ref": "./examples/SecurityContacts/UpdateSecurityContact_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Update", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }, { - "$ref": "#/parameters/SecurityContact" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings": { - "get": { - "x-ms-examples": { - "Get workspace settings on subscription": { - "$ref": "./examples/WorkspaceSettings/GetWorkspaceSettings_example.json" - } - }, - "tags": ["Workspace Settings"], - "description": "Settings about where we should store your security data and logs", - "operationId": "WorkspaceSettings_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSettingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings/{workspaceSettingName}": { - "get": { - "x-ms-examples": { - "Get a workspace setting on subscription": { - "$ref": "./examples/WorkspaceSettings/GetWorkspaceSetting_example.json" - } - }, - "tags": ["Workspace Settings"], - "description": "Settings about where we should store your security data and logs", - "operationId": "WorkspaceSettings_Get", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create a workspace setting data for subscription": { - "$ref": "./examples/WorkspaceSettings/CreateWorkspaceSetting_example.json" - } - }, - "tags": ["Workspace Settings"], - "description": "creating settings about where we should store your security data and logs", - "operationId": "WorkspaceSettings_Create", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }, { - "$ref": "#/parameters/WorkspaceSetting" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "patch": { - "x-ms-examples": { - "Update a workspace setting data for subscription": { - "$ref": "./examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json" - } - }, - "tags": ["Workspace Settings"], - "description": "Settings about where we should store your security data and logs", - "operationId": "WorkspaceSettings_Update", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }, { - "$ref": "#/parameters/WorkspaceSetting" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a workspace setting data for resource group": { - "$ref": "./examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json" - } - }, - "tags": ["Workspace Settings"], - "description": "Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace", - "operationId": "WorkspaceSettings_Delete", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings": { - "get": { - "x-ms-examples": { - "Get auto provisioning settings for subscription": { - "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json" - } - }, - "tags": ["AutoProvisioningSettings"], - "description": "Exposes the auto provisioning settings of the subscriptions", - "operationId": "AutoProvisioningSettings_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AutoProvisioningSettingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings/{settingName}": { - "get": { - "x-ms-examples": { - "Get an auto provisioning setting for subscription": { - "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json" - } - }, - "tags": ["AutoProvisioningSettings"], - "description": "Details of a specific setting", - "operationId": "AutoProvisioningSettings_Get", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/AutoProvisioningSettingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AutoProvisioningSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create auto provisioning settings for subscription": { - "$ref": "./examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json" - } - }, - "tags": ["AutoProvisioningSettings"], - "description": "Details of a specific setting", - "operationId": "AutoProvisioningSettings_Create", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, { - "$ref": "#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/AutoProvisioningSettingName" - }, { - "$ref": "#/parameters/AutoProvisioningSetting" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AutoProvisioningSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/compliances": { - "get": { - "x-ms-examples": { - "Get security compliance data over time": { - "$ref": "./examples/Compliances/GetCompliances_example.json" - } - }, - "tags": ["Compliances"], - "description": "The Compliance scores of the specific management group.", - "operationId": "Compliances_List", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Scope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComplianceList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/compliances/{complianceName}": { - "get": { - "x-ms-examples": { - "Get security compliance data for a day": { - "$ref": "./examples/Compliances/GetCompliance_example.json" - } - }, - "tags": ["Compliances"], - "description": "Details of a specific Compliance.", - "operationId": "Compliances_Get", - "parameters": [{ - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/Scope" - }, - { - "$ref": "#/parameters/ComplianceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Compliance" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings": { - "get": { - "x-ms-examples": { - "Get settings of subscription": { - "$ref": "./examples/Settings/GetSettings_example.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Settings about different configurations in security center", - "operationId": "Settings_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SettingsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}": { - "get": { - "x-ms-examples": { - "Get a setting on subscription": { - "$ref": "./examples/Settings/GetSetting_example.json" - } - }, - "tags": [ - "Settings" - ], - "description": "Settings of different configurations in security center", - "operationId": "Settings_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/SettingName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Update a setting for subscription": { - "$ref": "./examples/Settings/UpdateSetting_example.json" - } - }, - "tags": [ - "Settings" - ], - "description": "updating settings about different configurations in security center", - "operationId": "Settings_Update", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/SettingName" - }, - { - "$ref": "#/parameters/Setting" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "CloudError": { - "x-ms-external": true, - "type": "object", - "description": "Error response structure.", - "properties": { - "error": { - "x-ms-client-flatten": true, - "description": "Error data", - "$ref": "#/definitions/CloudErrorBody" - } - } - }, - "CloudErrorBody": { - "x-ms-external": true, - "type": "object", - "description": "Error details.", - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "readOnly": true, - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - } - } - }, - "Resource": { - "type": "object", - "description": "Describes an Azure resource.", - "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" - } - }, - "x-ms-azure-resource": true - }, - "Kind": { - "type": "object", - "description": "Describes an Azure resource with kind", - "properties": { - "kind": { - "type": "string", - "description": "Kind of the resource" - } - } - }, - "SecurityContactList": { - "type": "object", - "description": "List of security contacts response", - "properties": { - "value": { - "readOnly": true, - "description": "List of security contacts", - "type": "array", - "items": { - "$ref": "#/definitions/SecurityContact" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "SecurityContact": { - "type": "object", - "description": "Contact details for security issues", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Security contact data", - "$ref": "#/definitions/SecurityContactProperties" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - }] - }, - "SecurityContactProperties": { - "type": "object", - "description": "describes security contact properties", - "properties": { - "email": { - "type": "string", - "format": "email", - "description": "The email of this security contact" - }, - "phone": { - "type": "string", - "description": "The phone number of this security contact" - }, - "alertNotifications": { - "type": "string", - "enum": ["On", "Off"], - "x-ms-enum": { - "name": "alertNotifications", - "modelAsString": true, - "values": [{ - "value": "On", - "description": "Get notifications on new alerts" - }, - { - "value": "Off", - "description": "Don't get notifications on new alerts" - } - ] - }, - "description": "Whether to send security alerts notifications to the security contact" - }, - "alertsToAdmins": { - "type": "string", - "enum": ["On", "Off"], - "x-ms-enum": { - "name": "alertsToAdmins", - "modelAsString": true, - "values": [{ - "value": "On", - "description": "Send notification on new alerts to the subscription's admins" - }, - { - "value": "Off", - "description": "Don't send notification on new alerts to the subscription's admins" - } - ] - }, - "description": "Whether to send security alerts notifications to subscription admins" - } - }, - "required": [ - "email", - "phone", - "alertNotifications", - "alertsToAdmins" - ] - }, - "PricingList": { - "description": "List of pricing configurations response", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of pricing configurations", - "items": { - "$ref": "#/definitions/Pricing" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "Pricing": { - "type": "object", - "description": "Pricing tier will be applied for the scope based on the resource ID", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Pricing data", - "$ref": "#/definitions/PricingProperties" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - }] - }, - "PricingProperties": { - "type": "object", - "description": "Pricing data", - "properties": { - "pricingTier": { - "type": "string", - "description": "Pricing tier type", - "enum": ["Free", "Standard"], - "x-ms-enum": { - "name": "pricingTier", - "modelAsString": true, - "values": [{ - "value": "Free", - "description": "Get free Azure security center experience with basic security features" - }, - { - "value": "Standard", - "description": "Get the standard Azure security center experience with advanced security features" - } - ] - } - } - }, - "required": [ - "pricingTier" - ] - }, - "WorkspaceSettingList": { - "description": "List of workspace settings response", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "List of workspace settings", - "items": { - "$ref": "#/definitions/WorkspaceSetting" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "WorkspaceSetting": { - "type": "object", - "description": "Configures where to store the OMS agent data for workspaces under a scope", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Workspace setting data", - "$ref": "#/definitions/WorkspaceSettingProperties" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - }] - }, - "WorkspaceSettingProperties": { - "type": "object", - "description": "Workspace setting data", - "properties": { - "workspaceId": { - "type": "string", - "description": "The full Azure ID of the workspace to save the data in" - }, - "scope": { - "type": "string", - "description": "All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope" - } - }, - "required": [ - "workspaceId", - "scope" - ] - }, - "AutoProvisioningSettingList": { - "type": "object", - "description": "List of all the auto provisioning settings response", - "properties": { - "value": { - "description": "List of all the auto provisioning settings", - "type": "array", - "items": { - "$ref": "#/definitions/AutoProvisioningSetting" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "AutoProvisioningSetting": { - "type": "object", - "description": "Auto provisioning setting", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Auto provisioning setting data", - "$ref": "#/definitions/AutoProvisioningSettingProperties" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - }] - }, - "AutoProvisioningSettingProperties": { - "type": "object", - "description": "describes properties of an auto provisioning setting", - "properties": { - "autoProvision": { - "type": "string", - "description": "Describes what kind of security agent provisioning action to take", - "enum": ["On", "Off"], - "x-ms-enum": { - "name": "autoProvision", - "modelAsString": true, - "values": [{ - "value": "On", - "description": "Install missing security agent on VMs automatically" - }, - { - "value": "Off", - "description": "Do not install security agent on the VMs automatically" - } - ] - } - } - }, - "required": [ - "autoProvision" - ] - }, - "ComplianceList": { - "type": "object", - "readOnly": true, - "description": "List of Compliance objects response", - "properties": { - "value": { - "type": "array", - "description": "List of Compliance objects", - "items": { - "$ref": "#/definitions/Compliance" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "Compliance": { - "type": "object", - "readOnly": true, - "description": "Compliance of a scope", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Compliance data", - "$ref": "#/definitions/ComplianceProperties" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - }] - }, - "ComplianceProperties": { - "type": "object", - "description": "The Compliance score (percentage) of a Subscription is a sum of all Resources' Compliances under the given Subscription. A Resource Compliance is defined as the compliant ('healthy') Policy Definitions out of all Policy Definitions applicable to a given resource.", - "properties": { - "assessmentTimestampUtcDate": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The timestamp when the Compliance calculation was conducted." - }, - "resourceCount": { - "readOnly": true, - "type": "integer", - "description": "The resource count of the given subscription for which the Compliance calculation was conducted (needed for Management Group Compliance calculation)." - }, - "assessmentResult": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ComplianceSegment" - }, - "description": "An array of segment, which is the actually the compliance assessment." - } - } - }, - "ComplianceSegment": { - "type": "object", - "description": "A segment of a compliance assessment.", - "properties": { - "segmentType": { - "readOnly": true, - "type": "string", - "description": "The segment type, e.g. compliant, non-compliance, insufficient coverage, N/A, etc." - }, - "percentage": { - "type": "number", - "format": "double", - "readOnly": true, - "description": "The size (%) of the segment." - } - } - }, - "SettingsList": { - "type": "object", - "description": "Subscription settings list.", - "properties": { - "value": { - "type": "array", - "description": "The settings list.", - "items": { - "$ref": "#/definitions/Setting" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "Setting": { - "type": "object", - "description": "Represents a security setting in Azure Security Center.", - "discriminator": "kind", - "properties": {}, - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/SettingKind" - } - ] - }, - "DataExportSetting": { - "type": "object", - "description": "Represents a data export setting", - "x-ms-discriminator-value": "DataExportSetting", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Data export setting data", - "$ref": "#/definitions/DataExportSettingProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Setting" - } - ] - }, - "SettingKind": { - "type": "object", - "description": "The kind of the security setting", - "properties": { - "kind": { - "type": "string", - "description": "the kind of the settings string", - "enum": [ - "DataExportSetting" - ], - "x-ms-enum": { - "name": "SettingKind", - "modelAsString": true, - "values": [ - { - "value": "DataExportSetting" - } - ] - } - } - } - }, - "DataExportSettingProperties": { - "type": "object", - "description": "The data export setting properties", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is the data export setting is enabled" - } - }, - "required": [ - "enabled" - ] - } - }, - "parameters": { - "SubscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", - "type": "string", - "description": "Azure subscription ID" - }, - "ResourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, - "ApiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": ["2017-08-01-preview"], - "description": "API version for the operation" - }, - "Scope": { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).", - "x-ms-parameter-location": "method" - }, - "PricingName": { - "name": "pricingName", - "in": "path", - "required": true, - "type": "string", - "description": "name of the pricing configuration", - "x-ms-parameter-location": "method" - }, - "Pricing": { - "name": "pricing", - "in": "body", - "required": true, - "description": "Pricing object", - "schema": { - "$ref": "#/definitions/Pricing" - }, - "x-ms-parameter-location": "method" - }, - "SecurityContactName": { - "name": "securityContactName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the security contact object", - "x-ms-parameter-location": "method" - }, - "SecurityContact": { - "name": "securityContact", - "in": "body", - "required": true, - "description": "Security contact object", - "schema": { - "$ref": "#/definitions/SecurityContact" - }, - "x-ms-parameter-location": "method" - }, - "WorkspaceSettingName": { - "name": "workspaceSettingName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the security setting", - "x-ms-parameter-location": "method" - }, - "WorkspaceSetting": { - "name": "workspaceSetting", - "in": "body", - "required": true, - "description": "Security data setting object", - "schema": { - "$ref": "#/definitions/WorkspaceSetting" - }, - "x-ms-parameter-location": "method" - }, - "SettingName": { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of setting", - "enum": [ - "MCAS", - "WDATP" - ], - "x-ms-parameter-location": "method" - }, - "Setting": { - "name": "setting", - "in": "body", - "required": true, - "description": "Setting object", - "schema": { - "$ref": "#/definitions/Setting" - }, - "x-ms-parameter-location": "method" - }, - "AutoProvisioningSettingName": { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "description": "Auto provisioning setting key", - "x-ms-parameter-location": "method" - }, - "AutoProvisioningSetting": { - "name": "setting", - "in": "body", - "required": true, - "description": "Auto provisioning setting key", - "schema": { - "$ref": "#/definitions/AutoProvisioningSetting" - }, - "x-ms-parameter-location": "method" - }, - "ComplianceName": { - "name": "complianceName", - "in": "path", - "required": true, - "type": "string", - "description": "name of the Compliance", - "x-ms-parameter-location": "method" - } - } +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2017-08-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.Security/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingsSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configurations in the subscription", + "operationId": "Pricings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingsResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configurations in the resource group", + "operationId": "Pricings_ListByResourceGroup", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscriptionSecurity pricing configuration in the subscription", + "operationId": "Pricings_GetSubscriptionPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/PricingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update pricings on subscription": { + "$ref": "./examples/Pricings/CreatePricingsSubscription_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscription", + "operationId": "Pricings_UpdateSubscriptionPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/PricingName" + }, { + "$ref": "#/parameters/Pricing" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings/{pricingName}": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the resource group", + "operationId": "Pricings_GetResourceGroupPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }, { + "$ref": "#/parameters/PricingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update pricings on resource group": { + "$ref": "./examples/Pricings/CreatePricingsResourceGroup_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the resource group", + "operationId": "Pricings_CreateOrUpdateResourceGroupPricing", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/ResourceGroupName" + }, { + "$ref": "#/parameters/PricingName" + }, { + "$ref": "#/parameters/Pricing" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts": { + "get": { + "x-ms-examples": { + "Update security contact data": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContactList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { + "get": { + "x-ms-examples": { + "Get security contact data": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create security contact data": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }, { + "$ref": "#/parameters/SecurityContact" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete security contact data": { + "$ref": "./examples/SecurityContacts/DeleteSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Delete", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update security contact data": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Update", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }, { + "$ref": "#/parameters/SecurityContact" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings": { + "get": { + "x-ms-examples": { + "Get workspace settings on subscription": { + "$ref": "./examples/WorkspaceSettings/GetWorkspaceSettings_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/workspaceSettings/{workspaceSettingName}": { + "get": { + "x-ms-examples": { + "Get a workspace setting on subscription": { + "$ref": "./examples/WorkspaceSettings/GetWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create a workspace setting data for subscription": { + "$ref": "./examples/WorkspaceSettings/CreateWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "creating settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }, { + "$ref": "#/parameters/WorkspaceSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update a workspace setting data for subscription": { + "$ref": "./examples/WorkspaceSettings/UpdateWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Settings about where we should store your security data and logs", + "operationId": "WorkspaceSettings_Update", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }, { + "$ref": "#/parameters/WorkspaceSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace setting data for resource group": { + "$ref": "./examples/WorkspaceSettings/DeleteWorkspaceSetting_example.json" + } + }, + "tags": ["Workspace Settings"], + "description": "Deletes the custom workspace settings for this subscription. new VMs will report to the default workspace", + "operationId": "WorkspaceSettings_Delete", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings": { + "get": { + "x-ms-examples": { + "Get auto provisioning settings for subscription": { + "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Exposes the auto provisioning settings of the subscriptions", + "operationId": "AutoProvisioningSettings_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings/{settingName}": { + "get": { + "x-ms-examples": { + "Get an auto provisioning setting for subscription": { + "$ref": "./examples/AutoProvisioningSettings/GetAutoProvisioningSettingSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Details of a specific setting", + "operationId": "AutoProvisioningSettings_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/AutoProvisioningSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create auto provisioning settings for subscription": { + "$ref": "./examples/AutoProvisioningSettings/CreateAutoProvisioningSettingsSubscription_example.json" + } + }, + "tags": ["AutoProvisioningSettings"], + "description": "Details of a specific setting", + "operationId": "AutoProvisioningSettings_Create", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, { + "$ref": "#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/AutoProvisioningSettingName" + }, { + "$ref": "#/parameters/AutoProvisioningSetting" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Security/compliances": { + "get": { + "x-ms-examples": { + "Get security compliance data over time": { + "$ref": "./examples/Compliances/GetCompliances_example.json" + } + }, + "tags": ["Compliances"], + "description": "The Compliance scores of the specific management group.", + "operationId": "Compliances_List", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Scope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Security/compliances/{complianceName}": { + "get": { + "x-ms-examples": { + "Get security compliance data for a day": { + "$ref": "./examples/Compliances/GetCompliance_example.json" + } + }, + "tags": ["Compliances"], + "description": "Details of a specific Compliance.", + "operationId": "Compliances_Get", + "parameters": [{ + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Scope" + }, + { + "$ref": "#/parameters/ComplianceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Compliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings": { + "get": { + "x-ms-examples": { + "Get settings of subscription": { + "$ref": "./examples/Settings/GetSettings_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings about different configurations in security center", + "operationId": "Settings_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}": { + "get": { + "x-ms-examples": { + "Get a setting on subscription": { + "$ref": "./examples/Settings/GetSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Settings of different configurations in security center", + "operationId": "Settings_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a setting for subscription": { + "$ref": "./examples/Settings/UpdateSetting_example.json" + } + }, + "tags": [ + "Settings" + ], + "description": "updating settings about different configurations in security center", + "operationId": "Settings_Update", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + }, + { + "$ref": "#/parameters/Setting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "x-ms-external": true, + "type": "object", + "description": "Error response structure.", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Error data", + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", + "description": "Error details.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + } + }, + "Resource": { + "type": "object", + "description": "Describes an Azure resource.", + "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" + } + }, + "x-ms-azure-resource": true + }, + "Kind": { + "type": "object", + "description": "Describes an Azure resource with kind", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the resource" + } + } + }, + "SecurityContactList": { + "type": "object", + "description": "List of security contacts response", + "properties": { + "value": { + "readOnly": true, + "description": "List of security contacts", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityContact" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "SecurityContact": { + "type": "object", + "description": "Contact details for security issues", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Security contact data", + "$ref": "#/definitions/SecurityContactProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "SecurityContactProperties": { + "type": "object", + "description": "describes security contact properties", + "properties": { + "email": { + "type": "string", + "format": "email", + "description": "The email of this security contact" + }, + "phone": { + "type": "string", + "description": "The phone number of this security contact" + }, + "alertNotifications": { + "type": "string", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "alertNotifications", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Get notifications on new alerts" + }, + { + "value": "Off", + "description": "Don't get notifications on new alerts" + } + ] + }, + "description": "Whether to send security alerts notifications to the security contact" + }, + "alertsToAdmins": { + "type": "string", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "alertsToAdmins", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Send notification on new alerts to the subscription's admins" + }, + { + "value": "Off", + "description": "Don't send notification on new alerts to the subscription's admins" + } + ] + }, + "description": "Whether to send security alerts notifications to subscription admins" + } + }, + "required": [ + "email", + "phone", + "alertNotifications", + "alertsToAdmins" + ] + }, + "PricingList": { + "description": "List of pricing configurations response", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pricing configurations", + "items": { + "$ref": "#/definitions/Pricing" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Pricing": { + "type": "object", + "description": "Pricing tier will be applied for the scope based on the resource ID", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Pricing data", + "$ref": "#/definitions/PricingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "PricingProperties": { + "type": "object", + "description": "Pricing data", + "properties": { + "pricingTier": { + "type": "string", + "description": "Pricing tier type", + "enum": ["Free", "Standard"], + "x-ms-enum": { + "name": "pricingTier", + "modelAsString": true, + "values": [{ + "value": "Free", + "description": "Get free Azure security center experience with basic security features" + }, + { + "value": "Standard", + "description": "Get the standard Azure security center experience with advanced security features" + } + ] + } + } + }, + "required": [ + "pricingTier" + ] + }, + "WorkspaceSettingList": { + "description": "List of workspace settings response", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of workspace settings", + "items": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "WorkspaceSetting": { + "type": "object", + "description": "Configures where to store the OMS agent data for workspaces under a scope", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Workspace setting data", + "$ref": "#/definitions/WorkspaceSettingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "WorkspaceSettingProperties": { + "type": "object", + "description": "Workspace setting data", + "properties": { + "workspaceId": { + "type": "string", + "description": "The full Azure ID of the workspace to save the data in" + }, + "scope": { + "type": "string", + "description": "All the VMs in this scope will send their security data to the mentioned workspace unless overridden by a setting with more specific scope" + } + }, + "required": [ + "workspaceId", + "scope" + ] + }, + "AutoProvisioningSettingList": { + "type": "object", + "description": "List of all the auto provisioning settings response", + "properties": { + "value": { + "description": "List of all the auto provisioning settings", + "type": "array", + "items": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AutoProvisioningSetting": { + "type": "object", + "description": "Auto provisioning setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Auto provisioning setting data", + "$ref": "#/definitions/AutoProvisioningSettingProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "AutoProvisioningSettingProperties": { + "type": "object", + "description": "describes properties of an auto provisioning setting", + "properties": { + "autoProvision": { + "type": "string", + "description": "Describes what kind of security agent provisioning action to take", + "enum": ["On", "Off"], + "x-ms-enum": { + "name": "autoProvision", + "modelAsString": true, + "values": [{ + "value": "On", + "description": "Install missing security agent on VMs automatically" + }, + { + "value": "Off", + "description": "Do not install security agent on the VMs automatically" + } + ] + } + } + }, + "required": [ + "autoProvision" + ] + }, + "ComplianceList": { + "type": "object", + "readOnly": true, + "description": "List of Compliance objects response", + "properties": { + "value": { + "type": "array", + "description": "List of Compliance objects", + "items": { + "$ref": "#/definitions/Compliance" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Compliance": { + "type": "object", + "readOnly": true, + "description": "Compliance of a scope", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Compliance data", + "$ref": "#/definitions/ComplianceProperties" + } + }, + "allOf": [{ + "$ref": "#/definitions/Resource" + }] + }, + "ComplianceProperties": { + "type": "object", + "description": "The Compliance score (percentage) of a Subscription is a sum of all Resources' Compliances under the given Subscription. A Resource Compliance is defined as the compliant ('healthy') Policy Definitions out of all Policy Definitions applicable to a given resource.", + "properties": { + "assessmentTimestampUtcDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp when the Compliance calculation was conducted." + }, + "resourceCount": { + "readOnly": true, + "type": "integer", + "description": "The resource count of the given subscription for which the Compliance calculation was conducted (needed for Management Group Compliance calculation)." + }, + "assessmentResult": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceSegment" + }, + "description": "An array of segment, which is the actually the compliance assessment." + } + } + }, + "ComplianceSegment": { + "type": "object", + "description": "A segment of a compliance assessment.", + "properties": { + "segmentType": { + "readOnly": true, + "type": "string", + "description": "The segment type, e.g. compliant, non-compliance, insufficient coverage, N/A, etc." + }, + "percentage": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The size (%) of the segment." + } + } + }, + "SettingsList": { + "type": "object", + "description": "Subscription settings list.", + "properties": { + "value": { + "type": "array", + "description": "The settings list.", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "Setting": { + "type": "object", + "description": "Represents a security setting in Azure Security Center.", + "discriminator": "kind", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/SettingKind" + } + ] + }, + "DataExportSetting": { + "type": "object", + "description": "Represents a data export setting", + "x-ms-discriminator-value": "DataExportSetting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Data export setting data", + "$ref": "#/definitions/DataExportSettingProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ] + }, + "SettingKind": { + "type": "object", + "description": "The kind of the security setting", + "properties": { + "kind": { + "type": "string", + "description": "the kind of the settings string", + "enum": [ + "DataExportSetting" + ], + "x-ms-enum": { + "name": "SettingKind", + "modelAsString": true, + "values": [ + { + "value": "DataExportSetting" + } + ] + } + } + } + }, + "DataExportSettingProperties": { + "type": "object", + "description": "The data export setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the data export setting is enabled" + } + }, + "required": [ + "enabled" + ] + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "type": "string", + "description": "Azure subscription ID" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": ["2017-08-01-preview"], + "description": "API version for the operation" + }, + "Scope": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).", + "x-ms-parameter-location": "method" + }, + "PricingName": { + "name": "pricingName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the pricing configuration", + "x-ms-parameter-location": "method" + }, + "Pricing": { + "name": "pricing", + "in": "body", + "required": true, + "description": "Pricing object", + "schema": { + "$ref": "#/definitions/Pricing" + }, + "x-ms-parameter-location": "method" + }, + "SecurityContactName": { + "name": "securityContactName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the security contact object", + "x-ms-parameter-location": "method" + }, + "SecurityContact": { + "name": "securityContact", + "in": "body", + "required": true, + "description": "Security contact object", + "schema": { + "$ref": "#/definitions/SecurityContact" + }, + "x-ms-parameter-location": "method" + }, + "WorkspaceSettingName": { + "name": "workspaceSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the security setting", + "x-ms-parameter-location": "method" + }, + "WorkspaceSetting": { + "name": "workspaceSetting", + "in": "body", + "required": true, + "description": "Security data setting object", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + }, + "x-ms-parameter-location": "method" + }, + "SettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of setting", + "enum": [ + "MCAS", + "WDATP" + ], + "x-ms-parameter-location": "method" + }, + "Setting": { + "name": "setting", + "in": "body", + "required": true, + "description": "Setting object", + "schema": { + "$ref": "#/definitions/Setting" + }, + "x-ms-parameter-location": "method" + }, + "AutoProvisioningSettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "Auto provisioning setting key", + "x-ms-parameter-location": "method" + }, + "AutoProvisioningSetting": { + "name": "setting", + "in": "body", + "required": true, + "description": "Auto provisioning setting key", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + }, + "x-ms-parameter-location": "method" + }, + "ComplianceName": { + "name": "complianceName", + "in": "path", + "required": true, + "type": "string", + "description": "name of the Compliance", + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json index 824a53cc691d..dc2775e07732 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-1.json @@ -1,13 +1,13 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": {} - }, - "responses": { - "202": { - } - } -} +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": {} + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json index 4a0a56491d0b..48e257f80657 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-2.json @@ -1,19 +1,19 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": { - "BackupStorage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json index 79260361fa1d..c827d97d6c81 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/BackupPartition-3.json @@ -1,20 +1,20 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": { - "BackupStorage": { - "StorageKind": "FileShare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "mydomain\\backupaccount", - "PrimaryPassword": "abcd1234" - } - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "FileShare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "mydomain\\backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json index c71542c2be64..bccda97daa0e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateApplication-1.json @@ -1,16 +1,16 @@ -{ - "operationId": "CreateApplication", - "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.", - "parameters": { - "api-version": "6.0", - "ApplicationDescription": { - "Name": "fabric:/samples/CalcApp", - "TypeVersion": "1.0", - "TypeName": "CalculatorApp" - } - }, - "responses": { - "201": { - } - } -} +{ + "operationId": "CreateApplication", + "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.", + "parameters": { + "api-version": "6.0", + "ApplicationDescription": { + "Name": "fabric:/samples/CalcApp", + "TypeVersion": "1.0", + "TypeName": "CalculatorApp" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json index 6a57d125cf07..e12077c344f5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-1.json @@ -1,30 +1,30 @@ -{ - "operationId": "CreateBackupPolicy", - "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "BackupPolicyDescription": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "201": { - } - } +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "201": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json index 6a555d1397a6..8d6b8c0b2f65 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateBackupPolicy-2.json @@ -1,27 +1,27 @@ -{ - "operationId": "CreateBackupPolicy", - "description": "This example shows how to create a backup policy which takes backup every 10 minutes with file share as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "BackupPolicyDescription": { - "Name": "FileShare10MinBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT10M" - }, - "Storage": { - "StorageKind": "FileShare", - "FriendlyName": "FileShare_myshare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "backupaccount", - "PrimaryPassword": "abcd1234" - } - } - }, - "responses": { - "201": { - } - } +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup every 10 minutes with file share as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "BackupPolicyDescription": { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "201": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json index 87d2807cc3b8..bde8440d7677 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateName-1.json @@ -1,14 +1,14 @@ -{ - "operationId": "CreateName", - "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.", - "parameters": { - "api-version": "6.0", - "NameDescription": { - "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1" - } - }, - "responses": { - "201": { - } - } -} +{ + "operationId": "CreateName", + "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.", + "parameters": { + "api-version": "6.0", + "NameDescription": { + "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-1.json index 8b8c341523c2..c6186d87241b 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-1.json @@ -1,21 +1,21 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a basic stateless Service Fabric service.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateless", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test1", - "ServiceTypeName": "StatelessFrontendService", - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "InstanceCount": 4 - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateless Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 4 + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json index b8d3c24c9f78..8549e33566a4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-2.json @@ -1,23 +1,23 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a basic stateful Service Fabric service.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateful", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test2", - "ServiceTypeName": "StatefulBackendService", - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "HasPersistedState": false - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateful Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "HasPersistedState": false + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json index 1badea855fbb..5d7ea2bbafed 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-3.json @@ -1,47 +1,47 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateless", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test1", - "ServiceTypeName": "StatelessFrontendService", - "InitializationData": [], - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "InstanceCount": 2, - "PlacementConstraints": "Color==Blue", - "CorrelationScheme": [], - "ServiceLoadMetrics": [], - "ServicePlacementPolicies": [], - "DefaultMoveCost": "Low", - "IsDefaultMoveCostSpecified": true, - "ServicePackageActivationMode": "ExclusiveProcess", - "ServiceDnsName": "test1.test", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AveragePartitionLoad", - "MetricName": "servicefabric:\/_CpuCores", - "LowerLoadThreshold": 0.300000, - "UpperLoadThreshold": 0.800000, - "ScaleIntervalInSeconds": 600 - }, - "ScalingMechanism": { - "Kind": "PartitionInstanceCount", - "MinInstanceCount": 1, - "MaxInstanceCount": 6, - "ScaleIncrement": 2 - } - } - ] - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 2, + "PlacementConstraints": "Color==Blue", + "CorrelationScheme": [], + "ServiceLoadMetrics": [], + "ServicePlacementPolicies": [], + "DefaultMoveCost": "Low", + "IsDefaultMoveCostSpecified": true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ServiceDnsName": "test1.test", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.300000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 1, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json index d72ec8f3b457..3ee3ba13b666 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json @@ -1,44 +1,44 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateful", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test2", - "ServiceTypeName": "StatefulBackendService", - "InitializationData": [], - "PartitionDescription": { - "PartitionScheme": "NamedParitionSchemeDescription", - "Count" : 1, - "Names" : ["0"] - }, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize" : 2, - "HasPersistedState" : true, - "ServicePackageActivationMode": "ExclusiveProcess", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AverageServiceLoad", - "MetricName": "servicefabric:\/_MemoryInMB", - "LowerLoadThreshold": 500, - "UpperLoadThreshold": 900, - "ScaleIntervalInSeconds": 600 - }, - "ScalingMechanism": { - "Kind": "AddRemoveIncrementalNamedPartition", - "MinPartitionCount": 1, - "MaxPartitionCount": 3, - "ScaleIncrement": 1 - } - } - ] - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "NamedParitionSchemeDescription", + "Count" : 1, + "Names" : ["0"] + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize" : 2, + "HasPersistedState" : true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AverageServiceLoad", + "MetricName": "servicefabric:\/_MemoryInMB", + "LowerLoadThreshold": 500, + "UpperLoadThreshold": 900, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "AddRemoveIncrementalNamedPartition", + "MinPartitionCount": 1, + "MaxPartitionCount": 3, + "ScaleIncrement": 1 + } + } + ] + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json index 2eef49788ba9..bb4a059aca02 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DeleteBackupPolicy.json @@ -1,12 +1,12 @@ -{ - "operationId": "DeleteBackupPolicy", - "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "SampleBackupPolicy" - }, - "responses": { - "200": { - } - } +{ + "operationId": "DeleteBackupPolicy", + "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "SampleBackupPolicy" + }, + "responses": { + "200": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json index a2a85beaa18c..9c3f79dfcc49 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisableApplicationBackup", - "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisableApplicationBackup", + "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json index fd1eb6a6848d..d28c57331359 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisablePartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisablePartitionBackup", - "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisablePartitionBackup", + "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json index 8fc7ab651d64..a8d579114a69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/DisableServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisableServiceBackup", - "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisableServiceBackup", + "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json index e3782a25d8a3..32d2aebf9790 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableApplicationBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnableApplicationBackup", - "description": "This example shows how to enable periodic backup for a stateful application.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnableApplicationBackup", + "description": "This example shows how to enable periodic backup for a stateful application.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json index 6d596f0718c3..681f1a34a1c5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnablePartitionBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnablePartitionBackup", - "description": "This example shows how to enable periodic backup for a stateful partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnablePartitionBackup", + "description": "This example shows how to enable periodic backup for a stateful partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json index 4f5f81b3436d..a70aabb7eccc 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/EnableServiceBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnableServiceBackup", - "description": "This example shows how to enable periodic backup for a stateful service.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnableServiceBackup", + "description": "This example shows how to enable periodic backup for a stateful service.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json index 4f57cba22d2a..cdc5bde7b7fd 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-1.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetAllEntitiesBackedUpByPolicy", - "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/DemoApp", - "Items": [ - { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - }, - { - "EntityKind": "Application", - "ApplicationName": "fabric:/DemoApp" - } - ] - } - } - } -} +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/DemoApp", + "Items": [ + { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + }, + { + "EntityKind": "Application", + "ApplicationName": "fabric:/DemoApp" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json index 05d3854bdf38..a40150e05c98 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetAllEntitiesBackedUpByPolicy-2.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetAllEntitiesBackedUpByPolicy", - "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "MaxResults": 2, - "ContinuationToken": "fabric:/DemoApp" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "EntityKind": "Service", - "ServiceName": "fabric:/VotingApp/VotingActorService" - } - ] - } - } - } -} +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2, + "ContinuationToken": "fabric:/DemoApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "EntityKind": "Service", + "ServiceName": "fabric:/VotingApp/VotingActorService" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json index e95dfced7ef9..2cc70dd82d79 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-1.json @@ -1,40 +1,40 @@ -{ - "operationId": "GetApplicationBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService", - "Items": [ - { - "Kind": "Application", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ApplicationName": "fabric:/CalcApp", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - }, - { - "Kind": "Service", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService", + "Items": [ + { + "Kind": "Application", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ApplicationName": "fabric:/CalcApp", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Service", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json index 24a847b140c4..f1620fd55a75 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupConfigurationInfo-2.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetApplicationBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json index 08c914915123..7cee9f28ad86 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-1.json @@ -1,105 +1,105 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json index ac0fe0899e27..b0973826caf5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-2.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get the latest backup for each partition within an application.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get the latest backup for each partition within an application.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json index 1c08ced64a00..f2c47a889359 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json index 9cb6920d0c2c..0a79fb01b512 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationBackupList-4.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json index 22e0cd7a01c1..bd67cca12878 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationEventList.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetApplicationEventList", - "description": "This example shows how to get all application-related events during a certain time window.", - "parameters": { - "applicationId": "app1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App1Type", - "ApplicationTypeVersion": "1.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app1", - "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", - "TimeStamp": "2018-04-03T20:21:23.5774199Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetApplicationEventList", + "description": "This example shows how to get all application-related events during a certain time window.", + "parameters": { + "applicationId": "app1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json index cf3db52049cc..9d230b4a6666 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoByName-1.json @@ -1,27 +1,27 @@ -{ - "operationId": "GetApplicationInfo", - "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.", - "parameters": { - "api-version": "6.0", - "applicationId": "samples~CalculatorApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - }, - "204": { - "headers": {}, - "body": "" - } - } -} +{ + "operationId": "GetApplicationInfo", + "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.", + "parameters": { + "api-version": "6.0", + "applicationId": "samples~CalculatorApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json index fdfb2ddb517d..df1f287e4104 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-1.json @@ -1,39 +1,39 @@ -{ - "operationId": "GetApplicationInfoList", - "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.1", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/samples/PQueueApp1", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json index bdab44df784c..7b5ab210e830 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationInfoList-2.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetApplicationInfoList", - "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.1", - "MaxResults": 2, - "ContinuationToken": "fabric:/samples/PQueueApp1" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2, + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json index 7057ba96a7e4..a230d74d2b54 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-1.json @@ -1,86 +1,86 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.", - "parameters": { - "api-version": "6.0", - "MaxResults": 5 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueApp+2.0", - "Items": [ - { - "Name": "CalculatorApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "ServiceInstanceCount", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "CalculatorApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "ServiceInstanceCount", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "GatewayApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "GatewayPort", - "Value": "8505" - }, - { - "Key": "ServiceInstanceCount", - "Value": "1000" - } - ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueApp+2.0", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "GatewayPort", + "Value": "8505" + }, + { + "Key": "ServiceInstanceCount", + "Value": "1000" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json index ab3ffc6a26f3..c02bd96ace75 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-2.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "MaxResults": 5, - "ContinuationToken": "PersistentQueueApp+2.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Name": "VolatileQueueApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5, + "ContinuationToken": "PersistentQueueApp+2.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json index 123e89fa4520..47d3f9f6ee69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json @@ -1,61 +1,61 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", - "parameters": { - "api-version": "6.0", - "ExcludeApplicationParameters": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Name": "CalculatorApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "CalculatorApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "GatewayApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", + "parameters": { + "api-version": "6.0", + "ExcludeApplicationParameters": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json index f33d5314cd01..3e7ec703a345 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationsEventList.json @@ -1,37 +1,37 @@ -{ - "operationId": "GetApplicationsEventList", - "description": "This example shows how to get all applications-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App1Type", - "ApplicationTypeVersion": "1.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app1", - "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", - "TimeStamp": "2018-04-03T20:21:23.5774199Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App2Type", - "ApplicationTypeVersion": "4.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app2", - "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3", - "TimeStamp": "2018-04-03T20:21:59.74842Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetApplicationsEventList", + "description": "This example shows how to get all applications-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App2Type", + "ApplicationTypeVersion": "4.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app2", + "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3", + "TimeStamp": "2018-04-03T20:21:59.74842Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json index 84664d44b1d7..d48c65c8ed6a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyByName.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetBackupPolicyByName", - "description": "This example shows how to query a backup policy by name.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - } - } +{ + "operationId": "GetBackupPolicyByName", + "description": "This example shows how to query a backup policy by name.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json index a560bf05943e..b18863fab4d7 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-1.json @@ -1,54 +1,54 @@ -{ - "operationId": "GetBackupPolicyList", - "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "FileShare10MinBackupPolicy", - "Items": [ - { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - }, - { - "Name": "FileShare10MinBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT10M" - }, - "Storage": { - "StorageKind": "FileShare", - "FriendlyName": "FileShare_myshare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "backupaccount", - "PrimaryPassword": "****" - } - } - ] - } - } - } -} +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "FileShare10MinBackupPolicy", + "Items": [ + { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + }, + { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "****" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json index 8dd15c464676..3895a2315c81 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupPolicyList-2.json @@ -1,38 +1,38 @@ -{ - "operationId": "GetBackupPolicyList", - "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "ContinuationToken": "FileShare10MinBackupPolicy" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "AutoRestoreOnDataLoss": false, - "Name": "SampleBackupPolicy", - "MaxIncrementalBackups": 5, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT4H5M" - }, - "Storage": { - "Path": "\\\\myshare\\BackupStore", - "PrimaryUserName": "myuser1", - "PrimaryPassword": "****", - "SecondaryUserName": "myuser2", - "SecondaryPassword": "****", - "StorageKind": "FileShare", - "FriendlyName": "" - } - } - ] - } - } - } -} +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "ContinuationToken": "FileShare10MinBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "AutoRestoreOnDataLoss": false, + "Name": "SampleBackupPolicy", + "MaxIncrementalBackups": 5, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT4H5M" + }, + "Storage": { + "Path": "\\\\myshare\\BackupStore", + "PrimaryUserName": "myuser1", + "PrimaryPassword": "****", + "SecondaryUserName": "myuser2", + "SecondaryPassword": "****", + "StorageKind": "FileShare", + "FriendlyName": "" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json index b49a069ce5a7..8b1acfc03d76 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-1.json @@ -1,72 +1,72 @@ -{ - "operationId": "GetBackupsFromBackupLocation", - "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "GetBackupByStorageQueryDescription": { - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupEntity": { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - } - } - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json index d0dafc6acb99..b435bfc2fc58 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetBackupsFromBackupLocation-2.json @@ -1,73 +1,73 @@ -{ - "operationId": "GetBackupsFromBackupLocation", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "GetBackupByStorageQueryDescription": { - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupEntity": { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - } - }, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + }, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json index 4f0757539944..3a486b6fe298 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetChaosEvents.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetChaosEvents", - "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.", - "parameters": { - "api-version": "6.2", - "StartTimeUtc": "0", - "EndTimeUtc": "3155378975999999999" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "History": [ - { - "ChaosEvent": { - "Kind": "Started", - "TimeStampUtc": "2017-04-14T04:27:19.049Z", - "ChaosParameters": { - "MaxClusterStabilizationTimeoutInSeconds": 30, - "MaxConcurrentFaults": 3, - "WaitTimeBetweenIterationsInSeconds": 10, - "WaitTimeBetweenFaultsInSeconds": 1, - "TimeToRunInSeconds": "3600", - "EnableMoveReplicaFaults": true, - "ClusterHealthPolicy": { - "ConsiderWarningAsError": true, - "MaxPercentUnhealthyNodes": 0, - "MaxPercentUnhealthyApplications": 10, - "ApplicationTypeHealthPolicyMap": [ - { - "Key": "myapp", - "Value": 3 - } - ] - }, - "Context": { - "Map": { - "k1": "v1", - "k2": "v2", - "k3": "v5" - } - } - } - } - }, - { - "ChaosEvent": { - "Kind": "ExecutingFaults", - "TimeStampUtc": "2017-04-14T04:27:20.667Z", - "Faults": [ - "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622", - "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.", - "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762" - ] - } - } - ] - } - } - } -} +{ + "operationId": "GetChaosEvents", + "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.", + "parameters": { + "api-version": "6.2", + "StartTimeUtc": "0", + "EndTimeUtc": "3155378975999999999" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "History": [ + { + "ChaosEvent": { + "Kind": "Started", + "TimeStampUtc": "2017-04-14T04:27:19.049Z", + "ChaosParameters": { + "MaxClusterStabilizationTimeoutInSeconds": 30, + "MaxConcurrentFaults": 3, + "WaitTimeBetweenIterationsInSeconds": 10, + "WaitTimeBetweenFaultsInSeconds": 1, + "TimeToRunInSeconds": "3600", + "EnableMoveReplicaFaults": true, + "ClusterHealthPolicy": { + "ConsiderWarningAsError": true, + "MaxPercentUnhealthyNodes": 0, + "MaxPercentUnhealthyApplications": 10, + "ApplicationTypeHealthPolicyMap": [ + { + "Key": "myapp", + "Value": 3 + } + ] + }, + "Context": { + "Map": { + "k1": "v1", + "k2": "v2", + "k3": "v5" + } + } + } + } + }, + { + "ChaosEvent": { + "Kind": "ExecutingFaults", + "TimeStampUtc": "2017-04-14T04:27:20.667Z", + "Faults": [ + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622", + "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.", + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json index 1367a2991cc3..b3eaef4069de 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetClusterEventList.json @@ -1,56 +1,56 @@ -{ - "operationId": "GetClusterEventList", - "description": "This example shows how to get all cluster-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ClusterUpgradeStart", - "CurrentClusterVersion": "0.0.0.0:", - "TargetClusterVersion": "6.2:1.0", - "UpgradeType": "Rolling", - "RollingUpgradeMode": "UnmonitoredAuto", - "FailureAction": "Manual", - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:18:59.4313064Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeDomainComplete", - "TargetClusterVersion": "6.2:1.0", - "UpgradeState": "RollingForward", - "UpgradeDomains": "(0 1 2)", - "UpgradeDomainElapsedTimeInMs": 78.5288, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:19:59.5729953Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeDomainComplete", - "TargetClusterVersion": "6.2:1.0", - "UpgradeState": "RollingForward", - "UpgradeDomains": "(3 4)", - "UpgradeDomainElapsedTimeInMs": 0.0, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:20:59.6271949Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeComplete", - "TargetClusterVersion": "6.2:1.0", - "OverallUpgradeElapsedTimeInMs": 120196.5212, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:20:59.8134457Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetClusterEventList", + "description": "This example shows how to get all cluster-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ClusterUpgradeStart", + "CurrentClusterVersion": "0.0.0.0:", + "TargetClusterVersion": "6.2:1.0", + "UpgradeType": "Rolling", + "RollingUpgradeMode": "UnmonitoredAuto", + "FailureAction": "Manual", + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:18:59.4313064Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainComplete", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(0 1 2)", + "UpgradeDomainElapsedTimeInMs": 78.5288, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:19:59.5729953Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainComplete", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(3 4)", + "UpgradeDomainElapsedTimeInMs": 0.0, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.6271949Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeComplete", + "TargetClusterVersion": "6.2:1.0", + "OverallUpgradeElapsedTimeInMs": 120196.5212, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.8134457Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json index 7dc4ab531340..49a23ee30dc4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-1.json @@ -1,20 +1,20 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "HTTP Server started listening on port 8080\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "HTTP Server started listening on port 8080\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json index 14d00f2fbd60..0b1aec4546b8 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-2.json @@ -1,21 +1,21 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code", - "Tail": "10" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "UTC Time Now: 04\/02\/2018 22:06:31\r\nUTC Time Now: 04\/02\/2018 22:06:32\r\nUTC Time Now: 04\/02\/2018 22:06:33\r\nUTC Time Now: 04\/02\/2018 22:06:344\r\nUTC Time Now: 04\/02\/2018 22:06:35\r\nUTC Time Now: 04\/02\/2018 22:06:36\r\nUTC Time Now: 04\/02\/2018 22:06:37\r\nUTC Time Now: 04\/02\/2018 22:06:38\r\nUTC Time Now: 04\/02\/2018 22:06:39\r\nUTC Time Now: 04\/02\/2018 22:06:40\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Tail": "10" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "UTC Time Now: 04\/02\/2018 22:06:31\r\nUTC Time Now: 04\/02\/2018 22:06:32\r\nUTC Time Now: 04\/02\/2018 22:06:33\r\nUTC Time Now: 04\/02\/2018 22:06:344\r\nUTC Time Now: 04\/02\/2018 22:06:35\r\nUTC Time Now: 04\/02\/2018 22:06:36\r\nUTC Time Now: 04\/02\/2018 22:06:37\r\nUTC Time Now: 04\/02\/2018 22:06:38\r\nUTC Time Now: 04\/02\/2018 22:06:39\r\nUTC Time Now: 04\/02\/2018 22:06:40\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json index d188271fdf4f..5899e68003bc 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json @@ -1,21 +1,21 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code", - "Previous": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Previous": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json index 30fc6a7b6b3b..95d5da39df42 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetCorrelatedEventList.json @@ -1,31 +1,31 @@ -{ - "operationId": "GetCorrelatedEventList", - "description": "This example shows how to get all correlated events for a given eventInstanceId.", - "parameters": { - "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "Kind": "PartitionPrimaryMoveAnalysis", - "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z", - "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)", - "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)", - "MoveReason": "ApplicationHostDown", - "RelevantTraces": "", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963", - "TimeStamp": "2018-04-03T20:07:55.966073Z", - "HasCorrelatedEvents": true, - "Metadata": { - "Delay": "00:00:20", - "Duration": "00:01:59" - } - } - ] - } - } -} +{ + "operationId": "GetCorrelatedEventList", + "description": "This example shows how to get all correlated events for a given eventInstanceId.", + "parameters": { + "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "Kind": "PartitionPrimaryMoveAnalysis", + "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z", + "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)", + "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)", + "MoveReason": "ApplicationHostDown", + "RelevantTraces": "", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963", + "TimeStamp": "2018-04-03T20:07:55.966073Z", + "HasCorrelatedEvents": true, + "Metadata": { + "Delay": "00:00:20", + "Duration": "00:01:59" + } + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json index a32244dcd235..c303852becce 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress-Running.json @@ -1,19 +1,19 @@ -{ - "operationId": "GetDataLossProgress", - "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json index 2a5854f737cd..429c33c8f7b6 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDataLossProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetDataLossProgress", - "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "InvokeDataLossResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeDataLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json index 954cf260b781..63cd97b83abe 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json @@ -1,29 +1,29 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "applicationId": "samples~CalculatorApp", - "IncludeHealthState": "true" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp", - "HealthState": "Ok" - } - }, - "204": { - "headers": {}, - "body": "" - } - } +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "applicationId": "samples~CalculatorApp", + "IncludeHealthState": "true" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + } + }, + "204": { + "headers": {}, + "body": "" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json index f61fdb1b0967..452ac7b15380 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-1.json @@ -1,40 +1,40 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/samples/PQueueApp1", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", - "HealthState": "Unknown" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", - "HealthState": "Unknown" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Unknown" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json index 3fda665b418c..4bdb8b879f78 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-2.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetDeployedApplicationInfoListByName", - "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "ContinuationToken": "fabric:/samples/PQueueApp1" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", - "HealthState": "Unknown" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoListByName", + "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json index a3b2da108c3a..dd387f2ea57e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "IncludeHealthState": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", - "HealthState": "Ok" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", - "HealthState": "Ok" - }, - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", - "HealthState": "Ok" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "IncludeHealthState": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Ok" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json index a1833242ccec..692f55108319 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetFaultOperationList.json @@ -1,53 +1,53 @@ -{ - "operationId": "GetFaultOperationList", - "description": "This shows an example of possible output for GetFaultOperationList", - "parameters": { - "TypeFilter": "0xFF", - "StateFilter": "0xFF", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": - [ - { - "OperationId": "00000000-0000-0000-0000-000000000010", - "State": "Completed", - "Type": "PartitionDataLoss" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000020", - "State": "Completed", - "Type": "PartitionQuorumLoss" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000030", - "State": "Completed", - "Type": "PartitionRestart" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000500", - "State": "Faulted", - "Type": "NodeTransition" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000700", - "State": "Completed", - "Type": "NodeTransition" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000710", - "State": "Completed", - "Type": "NodeTransition" - }, - { - "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a", - "State": "Completed", - "Type": "PartitionRestart" - } - ] - } - } -} +{ + "operationId": "GetFaultOperationList", + "description": "This shows an example of possible output for GetFaultOperationList", + "parameters": { + "TypeFilter": "0xFF", + "StateFilter": "0xFF", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": + [ + { + "OperationId": "00000000-0000-0000-0000-000000000010", + "State": "Completed", + "Type": "PartitionDataLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000020", + "State": "Completed", + "Type": "PartitionQuorumLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000030", + "State": "Completed", + "Type": "PartitionRestart" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000500", + "State": "Faulted", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000700", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000710", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a", + "State": "Completed", + "Type": "PartitionRestart" + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json index 46e1abd19641..457cfd7986aa 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetImageStoreContent.json @@ -1,92 +1,92 @@ -{ - "operationId": "GetImageStoreContent", - "description": "This example shows how to get image store content under the given relative path.", - "parameters": { - "api-version": "6.2", - "contentPath": "Store\\CalcServiceApp" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "StoreFiles": [ - { - "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "23", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "897", - "ModifiedDate": "2017-09-28T17:44:22.609Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "25", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "26", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "27", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "19", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "744", - "ModifiedDate": "2017-09-28T17:44:22.578Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "24", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.484Z" - } - ], - "StoreFolders": [ - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0", - "FileCount": "2" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0", - "FileCount": "2" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0", - "FileCount": "2" - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreContent", + "description": "This example shows how to get image store content under the given relative path.", + "parameters": { + "api-version": "6.2", + "contentPath": "Store\\CalcServiceApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "StoreFiles": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "23", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "897", + "ModifiedDate": "2017-09-28T17:44:22.609Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "25", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "26", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "27", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "19", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "744", + "ModifiedDate": "2017-09-28T17:44:22.578Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "24", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.484Z" + } + ], + "StoreFolders": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0", + "FileCount": "2" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json index 5591529f395d..a21108addcbb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeEventList.json @@ -1,33 +1,33 @@ -{ - "operationId": "GetNodeEventList", - "description": "This example shows how to get all node-related events during a certain time window.", - "parameters": { - "nodeName": "node1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "NodeOpening", - "NodeInstance": 131672596159209215, - "NodeId": "ba001a8bb353543e646be031afb10f1e", - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "IpAddressOrFQDN": "100.78.240.56", - "Hostname": "RD0003FF5089AA", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node1", - "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", - "TimeStamp": "2018-04-03T20:06:55.966073Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetNodeEventList", + "description": "This example shows how to get all node-related events during a certain time window.", + "parameters": { + "nodeName": "node1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json index b629499ae376..3169bff0fae6 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeInfoList.json @@ -1,175 +1,175 @@ -{ - "operationId": "GetNodeInfoList", - "description": "This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.", - "parameters": { - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Name": "_Node_4", - "IpAddressOrFQDN": "localhost", - "Type": "NodeType4", - "CodeVersion": "5.6.135.9494", - "ConfigVersion": "1.0", - "NodeStatus": "Up", - "NodeUpTimeInSeconds": "526996", - "HealthState": "Ok", - "IsSeedNode": false, - "UpgradeDomain": "4", - "FaultDomain": "fd:/4", - "Id": { - "Id": "4f4e3698a196896b5efe8156cc4e1351" - }, - "InstanceId": "131353697443064929", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Invalid", - "NodeDeactivationStatus": "None", - "NodeDeactivationTask": [], - "PendingSafetyChecks": [] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-01-10T19:10:59.812Z", - "NodeDownAt": "0001-01-01T00:00:00.000Z" - }, - { - "Name": "_Node_3", - "IpAddressOrFQDN": "localhost", - "Type": "NodeType3", - "CodeVersion": "5.6.135.9494", - "ConfigVersion": "1.0", - "NodeStatus": "Up", - "NodeUpTimeInSeconds": "526954", - "HealthState": "Ok", - "IsSeedNode": false, - "UpgradeDomain": "3", - "FaultDomain": "fd:/3", - "Id": { - "Id": "6b5c3db003a0bd126f7b8a86fc3916a4" - }, - "InstanceId": "131353697864903666", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Invalid", - "NodeDeactivationStatus": "None", - "NodeDeactivationTask": [], - "PendingSafetyChecks": [] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-01-10T19:10:59.812Z", - "NodeDownAt": "0001-01-01T00:00:00.000Z" - }, - { - "Name": "_Node_2", - "IpAddressOrFQDN": "localhost", - "Type": "NodeType2", - "CodeVersion": "5.6.135.9494", - "ConfigVersion": "1.0", - "NodeStatus": "Disabled", - "NodeUpTimeInSeconds": "1710571", - "HealthState": "Ok", - "IsSeedNode": true, - "UpgradeDomain": "2", - "FaultDomain": "fd:/2", - "Id": { - "Id": "876a44d9185bf9416336b22e5d37cde8" - }, - "InstanceId": "131341861291227632", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Pause", - "NodeDeactivationStatus": "Completed", - "NodeDeactivationTask": [ - { - "NodeDeactivationTaskId": { - "Id": "876a44d9185bf9416336b22e5d37cde8", - "NodeDeactivationTaskType": "Client" - }, - "NodeDeactivationIntent": "Pause" - } - ], - "PendingSafetyChecks": [] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-01-10T19:10:59.812Z", - "NodeDownAt": "0001-01-01T00:00:00.000Z" - }, - { - "Name": "_Node_1", - "IpAddressOrFQDN": "localhost", - "Type": "NodeType1", - "CodeVersion": "5.6.135.9494", - "ConfigVersion": "1.0", - "NodeStatus": "Disabling", - "NodeUpTimeInSeconds": "1710571", - "HealthState": "Ok", - "IsSeedNode": true, - "UpgradeDomain": "1", - "FaultDomain": "fd:/1", - "Id": { - "Id": "a3784be1d81710242ed0a9632647b4f7" - }, - "InstanceId": "131341861290236579", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Pause", - "NodeDeactivationStatus": "SafetyCheckInProgress", - "NodeDeactivationTask": [ - { - "NodeDeactivationTaskId": { - "Id": "a3784be1d81710242ed0a9632647b4f7", - "NodeDeactivationTaskType": "Client" - }, - "NodeDeactivationIntent": "Pause" - } - ], - "PendingSafetyChecks": [ - { - "SafetyCheck": { - "Kind": "EnsureSeedNodeQuorum" - } - } - ] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-01-10T19:10:59.812Z", - "NodeDownAt": "0001-01-01T00:00:00.000Z" - }, - { - "Name": "_Node_0", - "IpAddressOrFQDN": "localhost", - "Type": "NodeType0", - "CodeVersion": "5.6.135.9494", - "ConfigVersion": "1.0", - "NodeStatus": "Up", - "NodeUpTimeInSeconds": "1710571", - "HealthState": "Ok", - "IsSeedNode": true, - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "Id": { - "Id": "bf865279ba277deb864a976fbf4c200e" - }, - "InstanceId": "131341861289826291", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Invalid", - "NodeDeactivationStatus": "None", - "NodeDeactivationTask": [], - "PendingSafetyChecks": [] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-01-10T19:10:59.812Z", - "NodeDownAt": "0001-01-01T00:00:00.000Z" - } - ] - } - } - } -} +{ + "operationId": "GetNodeInfoList", + "description": "This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.", + "parameters": { + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "_Node_4", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType4", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "526996", + "HealthState": "Ok", + "IsSeedNode": false, + "UpgradeDomain": "4", + "FaultDomain": "fd:/4", + "Id": { + "Id": "4f4e3698a196896b5efe8156cc4e1351" + }, + "InstanceId": "131353697443064929", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_3", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType3", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "526954", + "HealthState": "Ok", + "IsSeedNode": false, + "UpgradeDomain": "3", + "FaultDomain": "fd:/3", + "Id": { + "Id": "6b5c3db003a0bd126f7b8a86fc3916a4" + }, + "InstanceId": "131353697864903666", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_2", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType2", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Disabled", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "2", + "FaultDomain": "fd:/2", + "Id": { + "Id": "876a44d9185bf9416336b22e5d37cde8" + }, + "InstanceId": "131341861291227632", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Pause", + "NodeDeactivationStatus": "Completed", + "NodeDeactivationTask": [ + { + "NodeDeactivationTaskId": { + "Id": "876a44d9185bf9416336b22e5d37cde8", + "NodeDeactivationTaskType": "Client" + }, + "NodeDeactivationIntent": "Pause" + } + ], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_1", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType1", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Disabling", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "1", + "FaultDomain": "fd:/1", + "Id": { + "Id": "a3784be1d81710242ed0a9632647b4f7" + }, + "InstanceId": "131341861290236579", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Pause", + "NodeDeactivationStatus": "SafetyCheckInProgress", + "NodeDeactivationTask": [ + { + "NodeDeactivationTaskId": { + "Id": "a3784be1d81710242ed0a9632647b4f7", + "NodeDeactivationTaskType": "Client" + }, + "NodeDeactivationIntent": "Pause" + } + ], + "PendingSafetyChecks": [ + { + "SafetyCheck": { + "Kind": "EnsureSeedNodeQuorum" + } + } + ] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + }, + { + "Name": "_Node_0", + "IpAddressOrFQDN": "localhost", + "Type": "NodeType0", + "CodeVersion": "5.6.135.9494", + "ConfigVersion": "1.0", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "1710571", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "Id": { + "Id": "bf865279ba277deb864a976fbf4c200e" + }, + "InstanceId": "131341861289826291", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-01-10T19:10:59.812Z", + "NodeDownAt": "0001-01-01T00:00:00.000Z" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json index 901902f2ce40..64d4642700ea 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress-Running.json @@ -1,18 +1,18 @@ -{ - "operationId": "GetNodeTransitionProgress", - "description": "This shows an example of output when GetTransitionProgress has a State of Running.", - "parameters": { - "nodeName": "N0060", - "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of output when GetTransitionProgress has a State of Running.", + "parameters": { + "nodeName": "N0060", + "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json index 28a337aa3685..5ee8818ce76a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodeTransitionProgress.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetNodeTransitionProgress", - "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "nodeName": "N0060", - "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "NodeTransitionResult": { - "ErrorCode": 0, - "NodeResult": { - "NodeName": "N0060", - "NodeInstanceId": "131366982707950527" - } - } - } - } - } +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "nodeName": "N0060", + "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "NodeTransitionResult": { + "ErrorCode": 0, + "NodeResult": { + "NodeName": "N0060", + "NodeInstanceId": "131366982707950527" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json index 11cc67a0cc66..aae5dea1cc1c 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetNodesEventList.json @@ -1,47 +1,47 @@ -{ - "operationId": "GetNodesEventList", - "description": "This example shows how to get all nodes-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "NodeOpening", - "NodeInstance": 131672596159209215, - "NodeId": "ba001a8bb353543e646be031afb10f1e", - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "IpAddressOrFQDN": "100.78.240.56", - "Hostname": "RD0003FF5089AA", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node1", - "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", - "TimeStamp": "2018-04-03T20:06:55.966073Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "NodeOpening", - "NodeInstance": 131672596186027906, - "NodeId": "ba03ef91259835c54d674889849a7cee", - "UpgradeDomain": "3", - "FaultDomain": "fd:/3", - "IpAddressOrFQDN": "100.72.76.122", - "Hostname": "RD0003FF6047A8", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node2", - "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0", - "TimeStamp": "2018-04-03T20:06:58.6357365Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetNodesEventList", + "description": "This example shows how to get all nodes-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "NodeOpening", + "NodeInstance": 131672596186027906, + "NodeId": "ba03ef91259835c54d674889849a7cee", + "UpgradeDomain": "3", + "FaultDomain": "fd:/3", + "IpAddressOrFQDN": "100.72.76.122", + "Hostname": "RD0003FF6047A8", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node2", + "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0", + "TimeStamp": "2018-04-03T20:06:58.6357365Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json index 6784ad061fcd..48ffda64fa66 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupConfigurationInfo.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetPartitionBackupConfigurationInfo", - "description": "This example shows how to get backup configuration for a partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - } - } -} +{ + "operationId": "GetPartitionBackupConfigurationInfo", + "description": "This example shows how to get backup configuration for a partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json index 50a5c0bedd52..95228d16752f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-1.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json index 20e3c2e5fcbb..a8b808b8db3d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-2.json @@ -1,41 +1,41 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get the latest backup for the specified partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", - "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "639", - "CreationTimeUtc": "2018-01-02T08:59:53Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get the latest backup for the specified partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json index e934056ddad7..607b42eaa2cb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json index 5487bb20b6cb..0444cd5e8266 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupList-4.json @@ -1,42 +1,42 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", - "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "639", - "CreationTimeUtc": "2018-01-02T08:59:53Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json index 82f5824542da..9e0b2545db60 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionBackupProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetPartitionBackupProgress", - "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.", - "parameters": { - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "BackupState": "Success", - "TimeStampUtc": "2018-01-01T09:00:55Z", - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "FailureError": null - } - } - } +{ + "operationId": "GetPartitionBackupProgress", + "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "BackupState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "FailureError": null + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json index 744cc49add28..aae33c4b1e00 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionEventList.json @@ -1,38 +1,38 @@ -{ - "operationId": "GetPartitionEventList", - "description": "This example shows how to get all partition-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node1", - "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934595, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 203.1935, - "Phase3DurationMs": 0.0262, - "Phase4DurationMs": 628.8527, - "TotalDurationMs": 832.0724, - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "TimeStamp": "2018-04-03T20:21:47.3778996Z", - "HasCorrelatedEvents": true - } - ] - } - } -} +{ + "operationId": "GetPartitionEventList", + "description": "This example shows how to get all partition-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json index 7cc25203d70e..4453caa242d6 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestartProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetPartitionRestartProgress", - "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "RestartPartitionResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetPartitionRestartProgress", + "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "RestartPartitionResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json index 0d10b95e96ed..cd6099ad4d61 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionRestoreProgress.json @@ -1,24 +1,24 @@ -{ - "operationId": "GetPartitionRestoreProgress", - "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.", - "parameters": { - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "RestoreState": "Success", - "TimeStampUtc": "2018-01-01T09:00:55Z", - "RestoredEpoch": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "RestoredLsn": "261", - "FailureError": null - } - } - } +{ + "operationId": "GetPartitionRestoreProgress", + "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "RestoreState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "RestoredEpoch": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "RestoredLsn": "261", + "FailureError": null + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json index 201708dd62d1..dd7f4311823f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPartitionsEventList.json @@ -1,57 +1,57 @@ -{ - "operationId": "GetPartitionsEventList", - "description": "This example shows how to get all partitions-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node1", - "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934595, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 203.1935, - "Phase3DurationMs": 0.0262, - "Phase4DurationMs": 628.8527, - "TotalDurationMs": 832.0724, - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "TimeStamp": "2018-04-03T20:21:47.3778996Z", - "HasCorrelatedEvents": true - }, - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node2", - "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934596, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 205.667, - "Phase3DurationMs": 407.7781, - "Phase4DurationMs": 630.0935, - "TotalDurationMs": 1243.5386, - "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec", - "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86", - "TimeStamp": "2018-04-03T20:21:49.5155104Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionsEventList", + "description": "This example shows how to get all partitions-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + }, + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node2", + "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934596, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 205.667, + "Phase3DurationMs": 407.7781, + "Phase4DurationMs": 630.0935, + "TotalDurationMs": 1243.5386, + "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec", + "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86", + "TimeStamp": "2018-04-03T20:21:49.5155104Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json index 74665c5ff263..fd0e63e316bf 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfo-1.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetPropertyInfo", - "description": "This example shows how to get a Service Fabric property under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "PropertyName": "AppData" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Name": "CalculatorAppData", - "Value": { - "Kind": "String", - "Data": "1+2=3" - }, - "Metadata": { - "TypeId": "String", - "CustomTypeId": "EquationType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 12, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "12" - } - } - } - } -} +{ + "operationId": "GetPropertyInfo", + "description": "This example shows how to get a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyName": "AppData" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "CalculatorAppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "Metadata": { + "TypeId": "String", + "CustomTypeId": "EquationType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 12, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "12" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json index de3586fa9946..9d4f74b46e80 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-1.json @@ -1,43 +1,43 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to get all Service Fabric properties under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueAppData$131439231986491349", - "IsConsistent": true, - "Properties": [ - { - "Name": "CalculatorAppData", - "Metadata": { - "TypeId": "Int64", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "10" - } - }, - { - "Name": "PersistentQueueAppData", - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationDataType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", - "SequenceNumber": "12" - } - } - ] - - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json index 1475549419ca..405aeca605ff 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-2.json @@ -1,51 +1,51 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to get all Service Fabric properties and their values under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "IncludeValues": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueAppData$131439231986491349", - "IsConsistent": true, - "Properties": [ - { - "Name": "CalculatorAppData", - "Value": { - "Kind": "Int64", - "Data": "4534" - }, - "Metadata": { - "TypeId": "Int64", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 8, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "10" - } - }, - { - "Name": "PersistentQueueAppData", - "Value": { - "Kind": "Binary", - "Data": [6, 7, 8, 9, 10] - }, - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationDataType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", - "SequenceNumber": "12" - } - } - ] - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties and their values under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Value": { + "Kind": "Int64", + "Data": "4534" + }, + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [6, 7, 8, 9, 10] + }, + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json index ed04219db38f..51a4fcb919b4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetPropertyInfoList-3.json @@ -1,37 +1,37 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "IncludeValues": true, - "ContinuationToken": "PersistentQueueAppData$131439231986491349" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "Properties": [ - { - "Name": "VolatileQueueAppData", - "Value": { - "Kind": "Double", - "Data": 67.89 - }, - "Metadata": { - "TypeId": "Double", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 8, - "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z", - "SequenceNumber": "8" - } - } - ] - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true, + "ContinuationToken": "PersistentQueueAppData$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "Properties": [ + { + "Name": "VolatileQueueAppData", + "Value": { + "Kind": "Double", + "Data": 67.89 + }, + "Metadata": { + "TypeId": "Double", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z", + "SequenceNumber": "8" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json index 9789fb25cd70..059c51840fc9 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress-Running.json @@ -1,19 +1,19 @@ -{ - "operationId": "GetQuorumLossProgress", - "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json index 9c2391300712..3e848d89bc8d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetQuorumLossProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetQuorumLossProgress", - "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "InvokeQuorumLossResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeQuorumLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json index b9a1f76bc1a6..a89b8578ab44 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicaEventList.json @@ -1,36 +1,36 @@ -{ - "operationId": "GetPartitionReplicaEventList", - "description": "This example shows how to get all replica-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "replicaId": 131672608994209130, - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 131672608994209130, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677787, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:43:38Z", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "ReplicaId": 131672608994209130, - "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", - "TimeStamp": "2018-04-03T21:43:38.8904013Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionReplicaEventList", + "description": "This example shows how to get all replica-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "replicaId": 131672608994209130, + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json index 54dd7db48b5f..793b6d201db5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetReplicasEventList.json @@ -1,52 +1,52 @@ -{ - "operationId": "GetPartitionReplicasEventList", - "description": "This example shows how to get all replicas-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 131672608994209130, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677787, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:43:38Z", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "ReplicaId": 131672608994209130, - "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", - "TimeStamp": "2018-04-03T21:43:38.8904013Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 177872608994339550, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677788, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:44:38Z", - "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef", - "ReplicaId": 177872608994339550, - "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350", - "TimeStamp": "2018-04-03T21:44:38.8904013Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionReplicasEventList", + "description": "This example shows how to get all replicas-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 177872608994339550, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677788, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:44:38Z", + "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef", + "ReplicaId": 177872608994339550, + "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350", + "TimeStamp": "2018-04-03T21:44:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json index 438c3e22786d..9e7a54d9b89f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-1.json @@ -1,41 +1,41 @@ -{ - "operationId": "GetServiceBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "Items": [ - { - "Kind": "Service", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ServiceName": "fabric:/CalcApp/CalcService", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - }, - { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Partition", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Items": [ + { + "Kind": "Service", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Partition", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json index 321e25402e72..126c01ad5d60 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupConfigurationInfo-2.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetServiceBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Kind": "Partition", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json index d0ab2108240f..cb0c6c85b6a5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-1.json @@ -1,105 +1,105 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json index 3326573cc921..03d20cfcca7e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-2.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get the latest backup for each partition within a service.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get the latest backup for each partition within a service.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json index ff0fe9ea7c3e..3e0d3827a229 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json index 28dbfc7c2fa0..15482f3db270 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceBackupList-4.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json index 04241407ef2c..ae7adcc98ecf 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceEventList.json @@ -1,35 +1,35 @@ -{ - "operationId": "GetServiceEventList", - "description": "This example shows how to get all service-related events during a certain time window.", - "parameters": { - "serviceId": "app1~svc1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc1Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", - "ServiceId": "app1/svc1", - "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", - "TimeStamp": "2018-04-03T20:22:38.0560496Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetServiceEventList", + "description": "This example shows how to get all service-related events during a certain time window.", + "parameters": { + "serviceId": "app1~svc1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json index 617b06fe7e3e..092ac09a733e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json @@ -1,39 +1,39 @@ -{ - "operationId": "GetServiceTypeInfoByName", - "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", - "parameters": { - "api-version": "6.0", - "applicationTypeName": "Application2Type", - "ApplicationTypeVersion": "1.0.0", - "serviceTypeName": "Actor1ActorServiceType" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ServiceTypeDescription": { - "IsStateful": true, - "ServiceTypeName": "Actor1ActorServiceType", - "PlacementConstraints": "", - "HasPersistedState": true, - "Kind": "Stateful", - "Extensions": [ - { - "Key": "__GeneratedServiceType__", - "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " - } - ], - "LoadMetrics": [], - "ServicePlacementPolicies": [] - }, - "ServiceManifestVersion": "1.0.0", - "ServiceManifestName": "Actor1Pkg", - "IsServiceGroup": false - } - }, - "204": { - "headers": {}, - "body": "" - } - } -} +{ + "operationId": "GetServiceTypeInfoByName", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0", + "serviceTypeName": "Actor1ActorServiceType" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json index ccc292e62e0c..a4481bfa08c0 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoList-1.json @@ -1,36 +1,36 @@ -{ - "operationId": "GetServiceTypeInfoList", - "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.", - "parameters": { - "api-version": "6.0", - "applicationTypeName": "Application2Type", - "ApplicationTypeVersion": "1.0.0" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "ServiceTypeDescription": { - "IsStateful": true, - "ServiceTypeName": "Actor1ActorServiceType", - "PlacementConstraints": "", - "HasPersistedState": true, - "Kind": "Stateful", - "Extensions": [ - { - "Key": "__GeneratedServiceType__", - "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " - } - ], - "LoadMetrics": [], - "ServicePlacementPolicies": [] - }, - "ServiceManifestVersion": "1.0.0", - "ServiceManifestName": "Actor1Pkg", - "IsServiceGroup": false - } - ] - } - } -} +{ + "operationId": "GetServiceTypeInfoList", + "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json index 7a4c570cf344..bd4b7353165e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServicesEventList.json @@ -1,51 +1,51 @@ -{ - "operationId": "GetServicesEventList", - "description": "This example shows how to get all services-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc1Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", - "ServiceId": "app1/svc1", - "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", - "TimeStamp": "2018-04-03T20:22:38.0560496Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc2Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3", - "ServiceId": "app1/svc2", - "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318", - "TimeStamp": "2018-04-03T20:22:38.056197Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetServicesEventList", + "description": "This example shows how to get all services-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc2Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3", + "ServiceId": "app1/svc2", + "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318", + "TimeStamp": "2018-04-03T20:22:38.056197Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json index d2aad11d56b1..3d315a557a9f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-1.json @@ -1,22 +1,22 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to get information about all sub names of a given Service Fabric name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/CalculatorApp", - "fabric:/samples/mynames" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to get information about all sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/CalculatorApp", + "fabric:/samples/mynames" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json index 441fa7ea5da7..6dbd9309980a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-2.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples", - "Recursive": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/apps", - "fabric:/samples/data", - "fabric:/samples/CalculatorApp", - "fabric:/samples/CalculatorApp/CalculatorService", - "fabric:/samples/CalculatorApp/CalculatorService/Name-1", - "fabric:/samples/CalculatorApp/CalculatorService/Name-2", - "fabric:/samples/mynames/name-1" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps", + "fabric:/samples/data", + "fabric:/samples/CalculatorApp", + "fabric:/samples/CalculatorApp/CalculatorService", + "fabric:/samples/CalculatorApp/CalculatorService/Name-1", + "fabric:/samples/CalculatorApp/CalculatorService/Name-2", + "fabric:/samples/mynames/name-1" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json index 661dbcc22deb..3265fc8a3c13 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetSubNameInfoList-3.json @@ -1,24 +1,24 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "nameId": "samples", - "Recursive": true, - "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/apps/VolatileQueueApp", - "fabric:/samples/apps/NotepadApp" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true, + "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps/VolatileQueueApp", + "fabric:/samples/apps/NotepadApp" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json index 2cee9beefa54..21ce39b90dd9 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionById.json @@ -1,34 +1,34 @@ -{ - "operationId": "GetImageStoreUploadSessionById", - "description": "This example shows how to get image store upload session by a given ID.", - "parameters": { - "api-version": "6.0", - "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "UploadSessions": [ - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:06:37.260Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "402128" - }, - { - "StartPosition": "730105", - "EndPosition": "2097151" - } - ] - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreUploadSessionById", + "description": "This example shows how to get image store upload session by a given ID.", + "parameters": { + "api-version": "6.0", + "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:06:37.260Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "402128" + }, + { + "StartPosition": "730105", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json index 5f5ad736f03e..82743551c7cb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetUploadSessionByPath.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetImageStoreUploadSessionByPath", - "description": "This example shows how to get image store upload session by a given relative path.", - "parameters": { - "api-version": "6.0", - "contentPath": "SwaggerTest\\Common.dll" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "UploadSessions": [ - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:28:11.627Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "207615" - }, - { - "StartPosition": "626977", - "EndPosition": "2097151" - } - ] - }, - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:28:11.643Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "616947" - }, - { - "StartPosition": "1087529", - "EndPosition": "2097151" - } - ] - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreUploadSessionByPath", + "description": "This example shows how to get image store upload session by a given relative path.", + "parameters": { + "api-version": "6.0", + "contentPath": "SwaggerTest\\Common.dll" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.627Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "207615" + }, + { + "StartPosition": "626977", + "EndPosition": "2097151" + } + ] + }, + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.643Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "616947" + }, + { + "StartPosition": "1087529", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi.json index bb4610ae2e2d..cdaf407acf69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi.json @@ -1,27 +1,27 @@ -{ - "operationId": "InvokeContainerApi", - "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.", - "parameters": { - "api-version": "6.2", - "nodeName": "Node01", - "applicationId": "samples/winnodejs", - "ServiceManifestName": "NodeServicePackage", - "CodePackageName": "NodeService.Code", - "CodePackageInstanceId": "131668159770315380", - "ContainerApiRequestBody": { - "UriPath": "/containers/{id}/logs?stdout=true&stderr=true" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ContainerApiResult": { - "Status": 200, - "Content-Type": "text/plain; charset=utf-8", - "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n" - } - } - } - } +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "Node01", + "applicationId": "samples/winnodejs", + "ServiceManifestName": "NodeServicePackage", + "CodePackageName": "NodeService.Code", + "CodePackageInstanceId": "131668159770315380", + "ContainerApiRequestBody": { + "UriPath": "/containers/{id}/logs?stdout=true&stderr=true" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "text/plain; charset=utf-8", + "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json index dfbdcf541aef..1af58111eb46 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/InvokeContainerApi_Post.json @@ -1,29 +1,29 @@ -{ - "operationId": "InvokeContainerApi", - "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.", - "parameters": { - "api-version": "6.2", - "nodeName": "N0020", - "applicationId": "samples/nodejs1", - "ServiceManifestName": "NodeOnSF", - "CodePackageName": "Code", - "CodePackageInstanceId": "131673596679688285", - "ContainerApiRequestBody": { - "HttpVerb": "POST", - "UriPath": "/containers/{id}/update", - "Body": "{ \"CpuShares\": 512}" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ContainerApiResult": { - "Status": 200, - "Content-Type": "application/json", - "Body": "{\"Warnings\":null}\n" - } - } - } - } +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "N0020", + "applicationId": "samples/nodejs1", + "ServiceManifestName": "NodeOnSF", + "CodePackageName": "Code", + "CodePackageInstanceId": "131673596679688285", + "ContainerApiRequestBody": { + "HttpVerb": "POST", + "UriPath": "/containers/{id}/update", + "Body": "{ \"CpuShares\": 512}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "application/json", + "Body": "{\"Warnings\":null}\n" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json index 511aa04cf3ed..f2e3d3252d09 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-1.json @@ -1,19 +1,19 @@ -{ - "operationId": "PutProperty", - "description": "This example shows how to create or update a Service Fabric property under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps/CalculatorApp", - "PropertyDescription": { - "PropertyName": "AppData", - "Value": { - "Kind": "Binary", - "Data": [0, 1, 2, 3, 4, 5] - } - } - }, - "responses": { - "200": { - } - } -} +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "Binary", + "Data": [0, 1, 2, 3, 4, 5] + } + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json index 1d597a75d6c0..85713723d090 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/PutProperty-2.json @@ -1,20 +1,20 @@ -{ - "operationId": "PutProperty", - "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps/CalculatorApp", - "PropertyDescription": { - "PropertyName": "AppData", - "Value": { - "Kind": "String", - "Data": "1+2=3" - }, - "CustomTypeId": "EquationType" - } - }, - "responses": { - "200": { - } - } -} +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "CustomTypeId": "EquationType" + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json index 65f0d973e19b..2517de87856f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/RestorePartition.json @@ -1,21 +1,21 @@ -{ - "operationId": "RestorePartition", - "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "RestorePartitionDescription": { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupStorage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "RestorePartition", + "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "RestorePartitionDescription": { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json index 3a001609f1d3..c2c11c4f9d0a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumeApplicationBackup", - "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumeApplicationBackup", + "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json index a2adf7def604..f902b478d32e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumePartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumePartitionBackup", - "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumePartitionBackup", + "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json index 2a1dde5a6c07..69ea5b861c11 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/ResumeServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumeServiceBackup", - "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumeServiceBackup", + "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json index 3b8279165b6a..af100a680c95 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SubmitPropertyBatch-1.json @@ -1,67 +1,67 @@ -{ - "operationId": "SubmitPropertyBatch", - "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "PropertyBatchDescriptionList": { - "Operations": [ - { - "Kind": "CheckExists", - "PropertyName": "PersistentQueueAppData", - "Exits": true - }, - { - "Kind": "CheckSequence", - "PropertyName": "PersistentQueueAppData", - "SequenceNumber": "12" - }, - { - "Kind": "Put", - "PropertyName": "PersistentQueueAppData", - "Value": { - "Kind": "Binary", - "Data": [1, 2, 3, 4, 5] - }, - "CustomTypeId": "InitializationData" - }, - { - "Kind": "Get", - "PropertyName": "PersistentQueueAppData", - "IncludeValue": false - } - ] - } - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Kind": "Successful", - "Properties": { - "3": { - "Name": "PersistentQueueAppData", - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationData", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z", - "SequenceNumber": "13" - } - } - } - } - }, - "409": { - "headers": { - }, - "body": { - "Kind": "Failed", - "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED", - "OperationIndex": 1 - } - } - } -} +{ + "operationId": "SubmitPropertyBatch", + "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyBatchDescriptionList": { + "Operations": [ + { + "Kind": "CheckExists", + "PropertyName": "PersistentQueueAppData", + "Exits": true + }, + { + "Kind": "CheckSequence", + "PropertyName": "PersistentQueueAppData", + "SequenceNumber": "12" + }, + { + "Kind": "Put", + "PropertyName": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [1, 2, 3, 4, 5] + }, + "CustomTypeId": "InitializationData" + }, + { + "Kind": "Get", + "PropertyName": "PersistentQueueAppData", + "IncludeValue": false + } + ] + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Successful", + "Properties": { + "3": { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationData", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z", + "SequenceNumber": "13" + } + } + } + } + }, + "409": { + "headers": { + }, + "body": { + "Kind": "Failed", + "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED", + "OperationIndex": 1 + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json index 1a50c91da730..862c3b5387d8 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendApplicationBackup", - "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendApplicationBackup", + "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json index 62a9731b6936..74e24683205a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendPartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendPartitionBackup", - "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendPartitionBackup", + "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json index a61d4669f67d..f39d03482610 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/SuspendServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendServiceBackup", - "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendServiceBackup", + "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json index 7517350c76a6..5421b431a968 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateBackupPolicy.json @@ -1,31 +1,31 @@ -{ - "operationId": "UpdateBackupPolicy", - "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "BackupPolicyDescription": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "200": { - } - } +{ + "operationId": "UpdateBackupPolicy", + "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "200": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json index 094f2116cbaa..3a748e8e3e20 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-1.json @@ -1,34 +1,34 @@ -{ - "operationId": "UpdateService", - "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.", - "parameters": { - "serviceId": "test~test1", - "api-version": "6.0", - "ServiceUpdateDescription": { - "ServiceKind": "Stateless", - "Flags": "1568", - "PlacementConstraints": "Color==Red", - "DefaultMoveCost": "High", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AveragePartitionLoad", - "MetricName": "servicefabric:\/_CpuCores", - "LowerLoadThreshold": 0.500000, - "UpperLoadThreshold": 0.800000, - "ScaleIntervalInSeconds": 900 - }, - "ScalingMechanism": { - "Kind": "PartitionInstanceCount", - "MinInstanceCount": 4, - "MaxInstanceCount": 6, - "ScaleIncrement": 2 - } - } - ] - } - }, - "responses": { - "200": {} - } +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.", + "parameters": { + "serviceId": "test~test1", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateless", + "Flags": "1568", + "PlacementConstraints": "Color==Red", + "DefaultMoveCost": "High", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.500000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 900 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 4, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json index c5dca7b1cc6e..4329ddddf400 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/UpdateService-2.json @@ -1,17 +1,17 @@ -{ - "operationId": "UpdateService", - "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.", - "parameters": { - "serviceId": "test~test2", - "api-version": "6.0", - "ServiceUpdateDescription": { - "ServiceKind": "Stateful", - "Flags": "40", - "PlacementConstraints": "Color==Green", - "StandByReplicaKeepDurationSeconds": "1000" - } - }, - "responses": { - "200": {} - } +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.", + "parameters": { + "serviceId": "test~test2", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateful", + "Flags": "40", + "PlacementConstraints": "Color==Green", + "StandByReplicaKeepDurationSeconds": "1000" + } + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json index 3f5849cc896e..ab84ea8e86fa 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -1,24627 +1,24627 @@ -{ - "swagger": "2.0", - "info": { - "title": "Service Fabric Client APIs", - "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.", - "version": "6.2.0.9" - }, - "host": "localhost:19080", - "schemes": [ - "http", - "https" - ], - "produces": [ - "application/json" - ], - "paths": { - "/$/GetClusterManifest": { - "get": { - "operationId": "GetClusterManifest", - "summary": "Get the Service Fabric cluster manifest.", - "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster manifest information.", - "schema": { - "$ref": "#/definitions/ClusterManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterHealth": { - "get": { - "operationId": "GetClusterHealth", - "summary": "Gets the health of a Service Fabric cluster.", - "description": "Gets the health of a Service Fabric cluster.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health information.", - "schema": { - "$ref": "#/definitions/ClusterHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetClusterHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric cluster using the specified policy.", - "description": "Gets the health of a Service Fabric cluster.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health information.", - "schema": { - "$ref": "#/definitions/ClusterHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterHealthChunk": { - "get": { - "operationId": "GetClusterHealthChunk", - "summary": "Gets the health of a Service Fabric cluster using health chunks.", - "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", - "schema": { - "$ref": "#/definitions/ClusterHealthChunk" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters", - "summary": "Gets the health of a Service Fabric cluster using health chunks.", - "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", - "schema": { - "$ref": "#/definitions/ClusterHealthChunk" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/ReportClusterHealth": { - "post": { - "operationId": "ReportClusterHealth", - "summary": "Sends a health report on the Service Fabric cluster.", - "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetProvisionedCodeVersions": { - "get": { - "operationId": "GetProvisionedFabricCodeVersionInfoList", - "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.", - "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/CodeVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested provisioned code versions information.", - "schema": { - "$ref": "#/definitions/FabricCodeVersionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetProvisionedConfigVersions": { - "get": { - "operationId": "GetProvisionedFabricConfigVersionInfoList", - "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.", - "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ConfigVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested provisioned config versions information.", - "schema": { - "$ref": "#/definitions/FabricConfigVersionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetUpgradeProgress": { - "get": { - "operationId": "GetClusterUpgradeProgress", - "summary": "Gets the progress of the current cluster upgrade.", - "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, gets the last state of the previous cluster upgrade.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.", - "schema": { - "$ref": "#/definitions/ClusterUpgradeProgressObject" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterConfiguration": { - "get": { - "operationId": "GetClusterConfiguration", - "summary": "Get the Service Fabric standalone cluster configuration.", - "description": "Get the Service Fabric standalone cluster configuration. The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault and upgrade domain topologies, etc.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster configuration information.", - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterConfigurationUpgradeStatus": { - "get": { - "operationId": "GetClusterConfigurationUpgradeStatus", - "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.", - "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.", - "schema": { - "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetUpgradeOrchestrationServiceState": { - "get": { - "operationId": "GetUpgradeOrchestrationServiceState", - "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.", - "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceState" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/SetUpgradeOrchestrationServiceState": { - "post": { - "operationId": "SetUpgradeOrchestrationServiceState", - "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.", - "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Provision": { - "post": { - "summary": "Provision the code or configuration packages of a Service Fabric cluster.", - "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.", - "operationId": "ProvisionCluster", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the code or configuration packages have been provisioned." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Unprovision": { - "post": { - "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.", - "description": "Unprovision the code or configuration packages of a Service Fabric cluster. It is supported to unprovision code and configuration separately.", - "operationId": "UnprovisionCluster", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the code or configuration packages have been unprovisioned." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RollbackUpgrade": { - "post": { - "summary": "Rollback the upgrade of a Service Fabric cluster.", - "description": "Rollback the code or configuration upgrade of a Service Fabric cluster.", - "operationId": "RollbackClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "202": { - "description": "A successful response means that the rollback of a cluster upgrade has been initiated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/MoveToNextUpgradeDomain": { - "post": { - "summary": "Make the cluster upgrade move on to the next upgrade domain.", - "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.", - "operationId": "ResumeClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Upgrade": { - "post": { - "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.", - "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.", - "operationId": "StartClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "202": { - "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/StartClusterConfigurationUpgrade": { - "post": { - "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.", - "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.", - "operationId": "StartClusterConfigurationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "202": { - "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateUpgrade": { - "post": { - "operationId": "UpdateClusterUpgrade", - "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.", - "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetAadMetadata": { - "get": { - "operationId": "GetAadMetadata", - "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.", - "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "schemes": [ - "https" - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.", - "schema": { - "$ref": "#/definitions/AadMetadataObject" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes": { - "get": { - "summary": "Gets the list of nodes in the Service Fabric cluster.", - "description": "Gets the list of nodes in the Service Fabric cluster. The response includes the name, status, id, health, uptime, and other details about the node.", - "operationId": "GetNodeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Node" - ], - "x-ms-examples": { - "Get information about all nodes": { - "$ref": "./examples/GetNodeInfoList.json" - } - }, - "responses": { - "200": { - "description": "List of nodes in the cluster.", - "schema": { - "$ref": "#/definitions/PagedNodeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}": { - "get": { - "summary": "Gets the information about a specific node in the Service Fabric cluster.", - "description": "Gets the information about a specific node in the Service Fabric Cluster. The response includes the name, status, id, health, uptime, and other details about the node.", - "operationId": "GetNodeInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Node" - ], - "responses": { - "200": { - "description": "A successful operation will return information about the node with the specified nodeName.", - "schema": { - "$ref": "#/definitions/NodeInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified nodeName is not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetHealth": { - "get": { - "operationId": "GetNodeHealth", - "summary": "Gets the health of a Service Fabric node.", - "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/NodeHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetNodeHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric node, by using the specified health policy.", - "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/NodeHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/ReportHealth": { - "post": { - "operationId": "ReportNodeHealth", - "summary": "Sends a health report on the Service Fabric node.", - "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetLoadInformation": { - "get": { - "operationId": "GetNodeLoadInfo", - "summary": "Gets the load information of a Service Fabric node.", - "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node load information.", - "schema": { - "$ref": "#/definitions/NodeLoadInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Deactivate": { - "post": { - "operationId": "DisableNode", - "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.", - "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node which is was deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Activate": { - "post": { - "operationId": "EnableNode", - "summary": "Activate a Service Fabric cluster node which is currently deactivated.", - "description": "Activates a Service Fabric cluster node which is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/RemoveNodeState": { - "post": { - "operationId": "RemoveNodeState", - "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.", - "description": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can comes back up with its state intact.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Restart": { - "post": { - "operationId": "RestartNode", - "summary": "Restarts a Service Fabric cluster node.", - "description": "Restarts a Service Fabric cluster node that is already started.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes": { - "get": { - "summary": "Gets the list of application types in the Service Fabric cluster.", - "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. For example, if there are 10 application types but a page only fits the first 3 application types, or if max results is set to 3, then 3 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", - "operationId": "GetApplicationTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationTypeInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationTypeInfoList-2.json" - }, - "Exclude application parameters from the result": { - "$ref": "./examples/GetApplicationTypeInfoList-3.json" - } - }, - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "List of application types in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}": { - "get": { - "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.", - "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. For example, if there are 10 application types but a page only fits the first 3 application types, or if max results is set to 3, then 3 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", - "operationId": "GetApplicationTypeInfoListByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "List of application types in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/$/Provision": { - "post": { - "operationId": "ProvisionApplicationType", - "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.", - "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.", - "tags": [ - "ApplicationType" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful provision will return 200 status code." - }, - "202": { - "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { - "post": { - "operationId": "UnprovisionApplicationType", - "summary": "Removes or unregisters a Service Fabric application type from the cluster.", - "description": "Removes or unregisters a Service Fabric application type from the cluster. This operation can only be performed if all application instances of the application type has been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.", - "tags": [ - "ApplicationType" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful provision will return 200 status code." - }, - "202": { - "description": "A 202 status code indicates the operation was accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { - "get": { - "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.", - "operationId": "GetServiceTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "x-ms-examples": { - "Get information about all nodes.": { - "$ref": "./examples/GetServiceTypeInfoList-1.json" - } - }, - "responses": { - "200": { - "description": "List of service types that are supported by a provisioned application type.", - "schema": { - "$ref": "#/definitions/ServiceTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { - "get": { - "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", - "operationId": "GetServiceTypeInfoByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "x-ms-examples": { - "Get information about all nodes.": { - "$ref": "./examples/GetServiceTypeInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "A specific service type which supported by a provisioned application type.", - "schema": { - "$ref": "#/definitions/ServiceTypeInfo" - } - }, - "204": { - "description": "A 204 response is returned if the specified service type is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { - "get": { - "summary": "Gets the manifest describing a service type.", - "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.", - "operationId": "GetServiceManifest", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "Information about the service type.", - "schema": { - "$ref": "#/definitions/ServiceTypeManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": { - "get": { - "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.", - "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.", - "operationId": "GetDeployedServiceTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "List of information about service types of an application deployed on a node.", - "schema": { - "$ref": "#/definitions/DeployedServiceTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": { - "get": { - "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.", - "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.", - "operationId": "GetDeployedServiceTypeInfoByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "Information about service types of an application deployed on a node.", - "schema": { - "$ref": "#/definitions/DeployedServiceTypeInfoList" - } - }, - "204": { - "description": "An empty response is returned if the specified service type of the application is not deployed on the node." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/$/Create": { - "post": { - "summary": "Creates a Service Fabric application.", - "description": "Creates a Service Fabric application using the specified description.", - "operationId": "CreateApplication", - "x-ms-examples": { - "Create application.": { - "$ref": "./examples/CreateApplication-1.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "201": { - "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric application.", - "description": "Deletes an existing Service Fabric application. An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of the its services.", - "operationId": "DeleteApplication", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetLoadInformation": { - "get": { - "summary": "Gets load information about a Service Fabric application.", - "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.", - "operationId": "GetApplicationLoadInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "Information about the application load.", - "schema": { - "$ref": "#/definitions/ApplicationLoadInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications": { - "get": { - "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.", - "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.", - "operationId": "GetApplicationInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationInfoList-2.json" - } - }, - "responses": { - "200": { - "description": "List of applications created in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}": { - "get": { - "summary": "Gets information about a Service Fabric application.", - "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters and other details about the application.", - "operationId": "GetApplicationInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "x-ms-examples": { - "Get a specific application by application id": { - "$ref": "./examples/GetApplicationInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "Information about the application.", - "schema": { - "$ref": "#/definitions/ApplicationInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the service fabric application.", - "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.", - "operationId": "GetApplicationHealth", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested application health information.", - "schema": { - "$ref": "#/definitions/ApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetApplicationHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric application using the specified policy.", - "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/ApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/ReportHealth": { - "post": { - "operationId": "ReportApplicationHealth", - "summary": "Sends a health report on the Service Fabric application.", - "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/Upgrade": { - "post": { - "summary": "Starts upgrading an application in the Service Fabric cluster.", - "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.", - "operationId": "StartApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetUpgradeProgress": { - "get": { - "summary": "Gets details for the latest upgrade performed on this application.", - "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.", - "operationId": "GetApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "The application upgrade details.", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/UpdateUpgrade": { - "post": { - "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.", - "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.", - "operationId": "UpdateApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": { - "post": { - "summary": "Resumes upgrading an application in the Service Fabric cluster.", - "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.", - "operationId": "ResumeApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/RollbackUpgrade": { - "post": { - "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.", - "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to rollback the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.", - "operationId": "RollbackApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application has started to rollback. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications": { - "get": { - "operationId": "GetDeployedApplicationInfoList", - "summary": "Gets the list of applications deployed on a Service Fabric node.", - "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetDeployedApplicationInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetDeployedApplicationInfoList-2.json" - }, - "Include health state in the result": { - "$ref": "./examples/GetDeployedApplicationInfoList-3.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed application information.", - "schema": { - "$ref": "#/definitions/PagedDeployedApplicationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}": { - "get": { - "operationId": "GetDeployedApplicationInfo", - "summary": "Gets the information about an application deployed on a Service Fabric node.", - "description": "Gets the information about an application deployed on a Service Fabric node. This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get a specific deployed application by application ID and include the health state in the result": { - "$ref": "./examples/GetDeployedApplicationInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the information about the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified application is not deployed on the node." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": { - "get": { - "operationId": "GetDeployedApplicationHealth", - "summary": "Gets the information about health of an application deployed on a Service Fabric node.", - "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetDeployedApplicationHealthUsingPolicy", - "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.", - "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": { - "post": { - "operationId": "ReportDeployedApplicationHealth", - "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.", - "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { - "get": { - "summary": "Gets the manifest describing an application type.", - "description": "Gets the manifest describing an application type. The response contains the application manifest XML as a string.", - "operationId": "GetApplicationManifest", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "Information about the node.", - "schema": { - "$ref": "#/definitions/ApplicationTypeManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices": { - "get": { - "summary": "Gets the information about all services belonging to the application specified by the application id.", - "description": "Returns the information about all services belonging to the application specified by the application id.", - "operationId": "GetServiceInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "List of services in the cluster for the specified application.", - "schema": { - "$ref": "#/definitions/PagedServiceInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/{serviceId}": { - "get": { - "summary": "Gets the information about the specific service belonging to the Service Fabric application.", - "description": "Returns the information about the specified service belonging to the specified Service Fabric application.", - "operationId": "GetServiceInfo", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "Information about the specified service.", - "schema": { - "$ref": "#/definitions/ServiceInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified service is not part of the specified application." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetApplicationName": { - "get": { - "summary": "Gets the name of the Service Fabric application for a service.", - "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.", - "operationId": "GetApplicationNameInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "Information about the name of the application for the specified service.", - "schema": { - "$ref": "#/definitions/ApplicationNameInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/$/Create": { - "post": { - "operationId": "CreateService", - "summary": "Creates the specified Service Fabric service.", - "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.", - "x-ms-examples": { - "Basic stateless service": { - "$ref": "./examples/CreateService-1.json" - }, - "Basic stateful service": { - "$ref": "./examples/CreateService-2.json" - }, - "Stateless service with dns name and auto scaling": { - "$ref": "./examples/CreateService-3.json" - }, - "Stateful service with named partitions and auto scaling": { - "$ref": "./examples/CreateService-4.json" - } - }, - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": { - "post": { - "summary": "Creates a Service Fabric service from the service template.", - "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.", - "operationId": "CreateServiceFromTemplate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric service.", - "description": "Deletes an existing Service Fabric service. A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.", - "operationId": "DeleteService", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/Update": { - "post": { - "operationId": "UpdateService", - "summary": "Updates a Service Fabric service using the specified update description.", - "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Please note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.", - "x-ms-examples": { - "Stateless service": { - "$ref": "./examples/UpdateService-1.json" - }, - "Stateful service": { - "$ref": "./examples/UpdateService-2.json" - } - }, - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetDescription": { - "get": { - "summary": "Gets the description of an existing Service Fabric service.", - "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.", - "operationId": "GetServiceDescription", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the specified Service Fabric service.", - "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", - "operationId": "GetServiceHealth", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the specified service.", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.", - "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", - "operationId": "GetServiceHealthUsingPolicy", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the specified service.", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ReportHealth": { - "post": { - "operationId": "ReportServiceHealth", - "summary": "Sends a health report on the Service Fabric service.", - "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ResolvePartition": { - "get": { - "operationId": "ResolveService", - "summary": "Resolve a Service Fabric partition.", - "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.", - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam" - }, - { - "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/ResolvedServicePartition" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetPartitions": { - "get": { - "summary": "Gets the list of partitions of a Service Fabric service.", - "description": "Gets the list of partitions of a Service Fabric service. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", - "operationId": "GetPartitionInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "List of partitions of a Service Fabric service.", - "schema": { - "$ref": "#/definitions/PagedServicePartitionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}": { - "get": { - "summary": "Gets the information about a Service Fabric partition.", - "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", - "operationId": "GetPartitionInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the specified partition.", - "schema": { - "$ref": "#/definitions/ServicePartitionInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified partitionId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetServiceName": { - "get": { - "summary": "Gets the name of the Service Fabric service for a partition.", - "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.", - "operationId": "GetServiceNameInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the name of the service for the specified partition.", - "schema": { - "$ref": "#/definitions/ServiceNameInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the specified Service Fabric partition.", - "description": "Gets the health information of the specified partition.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.", - "operationId": "GetPartitionHealth", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information about the specified partition.", - "schema": { - "$ref": "#/definitions/PartitionHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.", - "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.", - "operationId": "GetPartitionHealthUsingPolicy", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information about the specified partition.", - "schema": { - "$ref": "#/definitions/PartitionHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ReportHealth": { - "post": { - "operationId": "ReportPartitionHealth", - "summary": "Sends a health report on the Service Fabric partition.", - "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetLoadInformation": { - "get": { - "summary": "Gets the load information of the specified Service Fabric partition.", - "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.", - "operationId": "GetPartitionLoadInformation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the specified partition's last reported load metrics.", - "schema": { - "$ref": "#/definitions/PartitionLoadInformation" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ResetLoad": { - "post": { - "operationId": "ResetPartitionLoad", - "summary": "Resets the current load of a Service Fabric partition.", - "description": "Resets the current load of a Service Fabric partition to the default load for the service.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Recover": { - "post": { - "operationId": "RecoverPartition", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/$/{serviceId}/$/GetPartitions/$/Recover": { - "post": { - "operationId": "RecoverServicePartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RecoverSystemPartitions": { - "post": { - "operationId": "RecoverSystemPartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RecoverAllPartitions": { - "post": { - "operationId": "RecoverAllPartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/CreateRepairTask": { - "post": { - "operationId": "CreateRepairTask", - "summary": "Creates a new repair task.", - "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/CancelRepairTask": { - "post": { - "operationId": "CancelRepairTask", - "summary": "Requests the cancellation of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/DeleteRepairTask": { - "post": { - "operationId": "DeleteRepairTask", - "summary": "Deletes a completed repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetRepairTaskList": { - "get": { - "operationId": "GetRepairTaskList", - "summary": "Gets a list of repair tasks matching the given filters.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.", - "schema": { - "$ref": "#/definitions/RepairTaskList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/ForceApproveRepairTask": { - "post": { - "operationId": "ForceApproveRepairTask", - "summary": "Forces the approval of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateRepairTaskHealthPolicy": { - "post": { - "operationId": "UpdateRepairTaskHealthPolicy", - "summary": "Updates the health policy of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateRepairExecutionState": { - "post": { - "operationId": "UpdateRepairExecutionState", - "summary": "Updates the execution state of a repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas": { - "get": { - "summary": "Gets the information about replicas of a Service Fabric service partition.", - "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the id, role, status, health, node name, uptime, and other details about the replica.", - "operationId": "GetReplicaInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "Information about the replicas of the specified partition.", - "schema": { - "$ref": "#/definitions/PagedReplicaInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { - "get": { - "summary": "Gets the information about a replica of a Service Fabric partition.", - "description": "The response includes the id, role, status, health, node name, uptime, and other details about the replica.", - "operationId": "GetReplicaInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "Information about the specified replicas of the specified partition of a Service Fabric service.", - "schema": { - "$ref": "#/definitions/ReplicaInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { - "get": { - "operationId": "GetReplicaHealth", - "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.", - "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested replica health.", - "schema": { - "$ref": "#/definitions/ReplicaHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetReplicaHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.", - "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested replica health information.", - "schema": { - "$ref": "#/definitions/ReplicaHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { - "post": { - "operationId": "ReportReplicaHealth", - "summary": "Sends a health report on the Service Fabric replica.", - "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": { - "get": { - "operationId": "GetDeployedServiceReplicaInfoList", - "summary": "Gets the list of replicas deployed on a Service Fabric node.", - "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaInfoList" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": { - "get": { - "operationId": "GetDeployedServiceReplicaDetailInfo", - "summary": "Gets the details of replica deployed on a Service Fabric node.", - "description": "Gets the details of the replica deployed on a Service Fabric node. The information include service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": { - "get": { - "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId", - "summary": "Gets the details of replica deployed on a Service Fabric node.", - "description": "Gets the details of the replica deployed on a Service Fabric node. The information include service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": { - "post": { - "operationId": "RestartReplica", - "summary": "Restarts a service replica of a persisted service running on a node.", - "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": { - "post": { - "operationId": "RemoveReplica", - "summary": "Removes a service replica running on a node.", - "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services.In addition, the forceRemove flag impacts all other replicas hosted in the same process.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": { - "get": { - "operationId": "GetDeployedServicePackageInfoList", - "summary": "Gets the list of service packages deployed on a Service Fabric node.", - "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service packages information.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": { - "get": { - "operationId": "GetDeployedServicePackageInfoListByName", - "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.", - "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service packages information." - }, - "204": { - "description": "An empty response is returned if the specified service package from the application is not deployed on the node.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { - "get": { - "operationId": "GetDeployedServicePackageHealth", - "summary": "Gets the information about health of an service package for a specific application deployed for a Service Fabric node and application.", - "description": "Gets the information about health of service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetDeployedServicePackageHealthUsingPolicy", - "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.", - "description": "Gets the information about health of an service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service Package" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": { - "post": { - "operationId": "ReportDeployedServicePackageHealth", - "summary": "Sends a health report on the Service Fabric deployed service package.", - "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/DeployServicePackage": { - "post": { - "operationId": "DeployServicePackageToNode", - "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.", - "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": { - "get": { - "operationId": "GetDeployedCodePackageInfoList", - "summary": "Gets the list of code packages deployed on a Service Fabric node.", - "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed code packages information.", - "schema": { - "$ref": "#/definitions/DeployedCodePackageInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": { - "post": { - "operationId": "RestartDeployedCodePackage", - "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.", - "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": { - "get": { - "operationId": "GetContainerLogsDeployedOnNode", - "summary": "Gets the container logs for container deployed on a Service Fabric node.", - "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TailOptionalQueryParam" - }, - { - "$ref": "#/parameters/PreviousOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get container logs for given code package": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json" - }, - "Get last 10 lines of container logs": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json" - }, - "Get container logs of previous dead container for given code package": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.", - "schema": { - "$ref": "#/definitions/ContainerLogs" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": { - "post": { - "operationId": "InvokeContainerApi", - "summary": "Invoke container API on a container deployed on a Service Fabric node.", - "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.", - "x-ms-examples": { - "Get container logs": { - "$ref": "./examples/InvokeContainerApi.json" - }, - "Update container": { - "$ref": "./examples/InvokeContainerApi_Post.json" - } - }, - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContainerApiRequiredBodyParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.", - "schema": { - "$ref": "#/definitions/ContainerApiResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/$/Create": { - "put": { - "summary": "Creates a Service Fabric compose deployment.", - "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created it's status can be tracked via `GetComposeDeploymentStatus` API.", - "operationId": "CreateComposeDeployment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}": { - "get": { - "summary": "Gets information about a Service Fabric compose deployment.", - "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status and other details about the deployment.", - "operationId": "GetComposeDeploymentStatus", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "Information about the compose deployment.", - "schema": { - "$ref": "#/definitions/ComposeDeploymentStatusInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments": { - "get": { - "summary": "Gets the list of compose deployments created in the Service Fabric cluster.", - "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.", - "operationId": "GetComposeDeploymentStatusList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "List of status of compose deployments in the cluster.", - "schema": { - "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": { - "get": { - "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.", - "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.", - "operationId": "GetComposeDeploymentUpgradeProgress", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "Details about the compose deployment upgrade.", - "schema": { - "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric compose deployment from cluster.", - "description": "Deletes an existing Service Fabric compose deployment.", - "operationId": "RemoveComposeDeployment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/Upgrade": { - "post": { - "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.", - "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.", - "operationId": "StartComposeDeploymentUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos": { - "get": { - "operationId": "GetChaos", - "summary": "Get the status of Chaos.", - "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the status of Chaos.", - "schema": { - "$ref": "#/definitions/Chaos" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/$/Start": { - "post": { - "operationId": "StartChaos", - "summary": "Starts Chaos in the cluster.", - "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nPlease refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-controlled-chaos) for more details.", - "tags": [ - "Chaos" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ChaosParametersRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/$/Stop": { - "post": { - "operationId": "StopChaos", - "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.", - "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.", - "tags": [ - "Chaos" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/Events": { - "get": { - "operationId": "GetChaosEvents", - "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.", - "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.", - "x-ms-examples": { - "Get Chaos events given a time range": { - "$ref": "./examples/GetChaosEvents.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "Next segment of Chaos events.", - "schema": { - "$ref": "#/definitions/ChaosEventsSegment" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/Schedule": { - "get": { - "operationId": "GetChaosSchedule", - "summary": "Get the Chaos Schedule defining when and how to run Chaos.", - "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.", - "schema": { - "$ref": "#/definitions/ChaosScheduleDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "PostChaosSchedule", - "summary": "Set the schedule used by Chaos.", - "description": "Set the Chaos Schedule currently in use by Chaos. Chaos will automatically schedule runs based on the Chaos Schedule.\nThe version in the provided input schedule must match the version of the Chaos Schedule on the server.\nIf the version provided does not match the version on the server, the Chaos Schedule is not updated.\nIf the version provided matches the version on the server, then the Chaos Schedule is updated and the version of the Chaos Schedule on the server is incremented up by one and wraps back to 0 after 2,147,483,647.\nIf Chaos is running when this call is made, the call will fail.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ChaosScheduleRequiredBodyParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}": { - "put": { - "summary": "Uploads contents of the file to the image store.", - "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.", - "operationId": "UploadFile", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "summary": "Gets the image store content information.", - "description": "Returns the information about the image store content at the specified contentPath relative to the root of the image store.", - "operationId": "GetImageStoreContent", - "x-ms-examples": { - "Get information about image store content under a given relative path": { - "$ref": "./examples/GetImageStoreContent.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store content information.", - "schema": { - "$ref": "#/definitions/ImageStoreContent" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes existing image store content.", - "description": "Deletes existing image store content being found within the given image store relative path. This can be used to delete uploaded application packages once they are provisioned.", - "operationId": "DeleteImageStoreContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore": { - "get": { - "summary": "Gets the content information at the root of the image store.", - "description": "Returns the information about the image store content at the root of the image store.", - "operationId": "GetImageStoreRootContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store content information.", - "schema": { - "$ref": "#/definitions/ImageStoreContent" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/Copy": { - "post": { - "summary": "Copies image store content internally", - "description": "Copies the image store content from the source image store relative path to the destination image store relative path.", - "operationId": "CopyImageStoreContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/DeleteUploadSession": { - "delete": { - "summary": "Cancels an image store upload session.", - "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.", - "operationId": "DeleteImageStoreUploadSession", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/CommitUploadSession": { - "post": { - "summary": "Commit an image store upload session.", - "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ", - "operationId": "CommitImageStoreUploadSession", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/GetUploadSession": { - "get": { - "summary": "Get the image store upload session by ID.", - "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ", - "operationId": "GetImageStoreUploadSessionById", - "x-ms-examples": { - "Get information about image store upload session by a given ID": { - "$ref": "./examples/GetUploadSessionById.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store upload session information.", - "schema": { - "$ref": "#/definitions/UploadSession" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}/$/GetUploadSession": { - "get": { - "summary": "Get the image store upload session by relative path.", - "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ", - "operationId": "GetImageStoreUploadSessionByPath", - "x-ms-examples": { - "Get information about image store upload session by a given relative path": { - "$ref": "./examples/GetUploadSessionByPath.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store upload session information.", - "schema": { - "$ref": "#/definitions/UploadSession" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}/$/UploadChunk": { - "put": { - "summary": "Uploads a file chunk to the image store relative path.", - "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.", - "operationId": "UploadFileChunk", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/InvokeInfrastructureCommand": { - "post": { - "operationId": "InvokeInfrastructureCommand", - "summary": "Invokes an administrative command on the given Infrastructure Service instance.", - "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Infrastructure" - ], - "responses": { - "200": { - "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", - "schema": { - "$ref": "#/definitions/InfrastructureServiceResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/InvokeInfrastructureQuery": { - "get": { - "operationId": "InvokeInfrastructureQuery", - "summary": "Invokes a read-only query on the given infrastructure service instance.", - "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Infrastructure" - ], - "responses": { - "200": { - "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", - "schema": { - "$ref": "#/definitions/InfrastructureServiceResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": { - "post": { - "operationId": "StartDataLoss", - "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.", - "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode\nPartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\nFullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/DataLossModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": { - "get": { - "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.", - "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.", - "operationId": "GetDataLossProgress", - "x-ms-examples": { - "Gets information about a partition data loss operation. In this case the operation has a State of Completed": { - "$ref": "./examples/GetDataLossProgress.json" - }, - "Get information about a partition data loss operation. In this case the operation is a State of Running": { - "$ref": "./examples/GetDataLossProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of the partition data loss operation.", - "schema": { - "$ref": "#/definitions/PartitionDataLossProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": { - "post": { - "operationId": "StartQuorumLoss", - "summary": "Induces quorum loss for a given stateful service partition.", - "description": "Induces quorum loss for a given stateful service partition. This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/QuorumLossModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": { - "get": { - "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.", - "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.", - "operationId": "GetQuorumLossProgress", - "x-ms-examples": { - "Gets information about a completed quorum loss operation": { - "$ref": "./examples/GetQuorumLossProgress.json" - }, - "Gets information about a running quorum operation operation": { - "$ref": "./examples/GetQuorumLossProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a partition quorum loss operation.", - "schema": { - "$ref": "#/definitions/PartitionQuorumLossProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": { - "post": { - "operationId": "StartPartitionRestart", - "summary": "This API will restart some or all replicas or instances of the specified partition.", - "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": { - "get": { - "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.", - "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.", - "operationId": "GetPartitionRestartProgress", - "x-ms-examples": { - "Get information a completed PartitionRestart operation": { - "$ref": "./examples/GetPartitionRestartProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a partition restart operation.", - "schema": { - "$ref": "#/definitions/PartitionRestartProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Nodes/{nodeName}/$/StartTransition/": { - "post": { - "operationId": "StartNodeTransition", - "summary": "Starts or stops a cluster node.", - "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": { - "get": { - "summary": "Gets the progress of an operation started using StartNodeTransition.", - "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.", - "operationId": "GetNodeTransitionProgress", - "x-ms-examples": { - "Gets information about a completed NodeTransition operation": { - "$ref": "./examples/GetNodeTransitionProgress.json" - }, - "Gets information about a running NodeTransition operation": { - "$ref": "./examples/GetNodeTransitionProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a node transition operation.", - "schema": { - "$ref": "#/definitions/NodeTransitionProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/": { - "get": { - "operationId": "GetFaultOperationList", - "summary": "Gets a list of user-induced fault operations filtered by provided input.", - "description": "Gets the a list of user-induced fault operations filtered by provided input.", - "x-ms-examples": { - "Gets information on fault operations": { - "$ref": "./examples/GetFaultOperationList.json" - } - }, - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TypeFilterRequiredQueryParam" - }, - { - "$ref": "#/parameters/StateFilterRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/OperationStatusList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/$/Cancel": { - "post": { - "operationId": "CancelOperation", - "summary": "Cancels a user-induced fault operation.", - "description": "The following is a list of APIs that start fault operations that may be cancelled using CancelOperation -\n- StartDataLoss\n- StartQuorumLoss\n- StartPartitionRestart\n- StartNodeTransition\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will/is be cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/ForceRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/$/Create": { - "post": { - "operationId": "CreateBackupPolicy", - "summary": "Creates a backup policy.", - "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.", - "x-ms-examples": { - "Create a time based backup policy with Azure as backup location": { - "$ref": "./examples/CreateBackupPolicy-1.json" - }, - "Create a frequency based backup policy with file share as backup location": { - "$ref": "./examples/CreateBackupPolicy-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "201": { - "description": "A sucessful operation returns 201 status code and creates a new backup policy." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": { - "post": { - "operationId": "DeleteBackupPolicy", - "summary": "Deletes the backup policy.", - "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.", - "x-ms-examples": { - "Delete backup policy": { - "$ref": "./examples/DeleteBackupPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and deletes the backup policy." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies": { - "get": { - "operationId": "GetBackupPolicyList", - "summary": "Gets all the backup policies configured.", - "description": "Get a list of all the backup policies configured.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetBackupPolicyList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetBackupPolicyList-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and paged list of backup policies.", - "schema": { - "$ref": "#/definitions/PagedBackupPolicyDescriptionList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}": { - "get": { - "operationId": "GetBackupPolicyByName", - "summary": "Gets a particular backup policy by name.", - "description": "Gets a particular backup policy identified by {backupPolicyName}", - "x-ms-examples": { - "Get backup policy by name": { - "$ref": "./examples/GetBackupPolicyByName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the backup policy description.", - "schema": { - "$ref": "#/definitions/BackupPolicyDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": { - "get": { - "operationId": "GetAllEntitiesBackedUpByPolicy", - "summary": "Gets the list of backup entities that are associated with this policy.", - "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.", - "schema": { - "$ref": "#/definitions/PagedBackupEntityList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": { - "post": { - "operationId": "UpdateBackupPolicy", - "summary": "Updates the backup policy.", - "description": "Updates the backup policy identified by {backupPolicyName}", - "x-ms-examples": { - "Update backup policy": { - "$ref": "./examples/UpdateBackupPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A sucessful operation resturns 200 status code and updates the backup policy description." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/EnableBackup": { - "post": { - "operationId": "EnableApplicationBackup", - "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.", - "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable application backup": { - "$ref": "./examples/EnableApplicationBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable application backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/DisableBackup": { - "post": { - "operationId": "DisableApplicationBackup", - "summary": "Disables periodic backup of Service Fabric application.", - "description": "Disables periodic backup of Service Fabric application which was previously enabled.", - "x-ms-examples": { - "Disable application backup": { - "$ref": "./examples/DisableApplicationBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable application backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetApplicationBackupConfigurationInfo", - "summary": "Gets the Service Fabric application backup configuration information.", - "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.", - "schema": { - "$ref": "#/definitions/PagedBackupConfigurationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetBackups": { - "get": { - "operationId": "GetApplicationBackupList", - "summary": "Gets the list of backups available for every partition in this application.", - "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetApplicationBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetApplicationBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetApplicationBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendApplicationBackup", - "summary": "Suspends periodic backup for the specified Service Fabric application.", - "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.", - "x-ms-examples": { - "Suspend application backup": { - "$ref": "./examples/SuspendApplicationBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/ResumeBackup": { - "post": { - "operationId": "ResumeApplicationBackup", - "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.", - "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume application backup": { - "$ref": "./examples/ResumeApplicationBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/EnableBackup": { - "post": { - "operationId": "EnableServiceBackup", - "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.", - "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable service backup": { - "$ref": "./examples/EnableServiceBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable service backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/DisableBackup": { - "post": { - "operationId": "DisableServiceBackup", - "summary": "Disables periodic backup of Service Fabric service which was previously enabled.", - "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.", - "x-ms-examples": { - "Disable service backup": { - "$ref": "./examples/DisableServiceBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable service backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetServiceBackupConfigurationInfo", - "summary": "Gets the Service Fabric service backup configuration information.", - "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.", - "schema": { - "$ref": "#/definitions/PagedBackupConfigurationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetBackups": { - "get": { - "operationId": "GetServiceBackupList", - "summary": "Gets the list of backups available for every partition in this service.", - "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetServiceBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetServiceBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetServiceBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetServiceBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendServiceBackup", - "summary": "Suspends periodic backup for the specified Service Fabric service.", - "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.", - "x-ms-examples": { - "Suspend service backup": { - "$ref": "./examples/SuspendServiceBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ResumeBackup": { - "post": { - "operationId": "ResumeServiceBackup", - "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.", - "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume service backup": { - "$ref": "./examples/ResumeServiceBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/EnableBackup": { - "post": { - "operationId": "EnablePartitionBackup", - "summary": "Enables periodic backup of the stateful persisted partition.", - "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable partition backup": { - "$ref": "./examples/EnablePartitionBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable partition backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/DisableBackup": { - "post": { - "operationId": "DisablePartitionBackup", - "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.", - "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.", - "x-ms-examples": { - "Disable partition backup": { - "$ref": "./examples/DisablePartitionBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable partition backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetPartitionBackupConfigurationInfo", - "summary": "Gets the partition backup configuration information", - "description": "Gets the Service Fabric Backup configuration information for the specified partition.", - "x-ms-examples": { - "Get partition backup configuration information": { - "$ref": "./examples/GetPartitionBackupConfigurationInfo.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.", - "schema": { - "$ref": "#/definitions/PartitionBackupConfigurationInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackups": { - "get": { - "operationId": "GetPartitionBackupList", - "summary": "Gets the list of backups available for the specified partition.", - "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetPartitionBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetPartitionBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetPartitionBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetPartitionBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendPartitionBackup", - "summary": "Suspends periodic backup for the specified partition.", - "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.", - "x-ms-examples": { - "Suspend partition backup": { - "$ref": "./examples/SuspendPartitionBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ResumeBackup": { - "post": { - "operationId": "ResumePartitionBackup", - "summary": "Resumes periodic backup of partition which was previously suspended.", - "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume partition backup": { - "$ref": "./examples/ResumePartitionBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Backup": { - "post": { - "operationId": "BackupPartition", - "summary": "Triggers backup of the partition's state.", - "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.", - "x-ms-examples": { - "Backup partition": { - "$ref": "./examples/BackupPartition-1.json" - }, - "Backup partition to a specific Azure storage account": { - "$ref": "./examples/BackupPartition-2.json" - }, - "Backup partition to a specific on-premise file share": { - "$ref": "./examples/BackupPartition-3.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam" - }, - { - "$ref": "#/parameters/BackupTimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackupProgress": { - "get": { - "operationId": "GetPartitionBackupProgress", - "summary": "Gets details for the latest backup triggered for this partition.", - "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.", - "x-ms-examples": { - "Get backup operation progress": { - "$ref": "./examples/GetPartitionBackupProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and backup progress details.", - "schema": { - "$ref": "#/definitions/BackupProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Restore": { - "post": { - "operationId": "RestorePartition", - "summary": "Triggers restore of the state of the partition using the specified restore partition description.", - "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.", - "x-ms-examples": { - "Trigger partition restore": { - "$ref": "./examples/RestorePartition.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetRestoreProgress": { - "get": { - "operationId": "GetPartitionRestoreProgress", - "summary": "Gets details for the latest restore operation triggered for this partition.", - "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.", - "x-ms-examples": { - "Get restore operation progress": { - "$ref": "./examples/GetPartitionRestoreProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and restore progress details.", - "schema": { - "$ref": "#/definitions/RestoreProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/$/GetBackups": { - "post": { - "operationId": "GetBackupsFromBackupLocation", - "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.", - "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetBackupsFromBackupLocation-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetBackupsFromBackupLocation-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/$/Create": { - "post": { - "summary": "Creates a Service Fabric name.", - "description": "Creates the specified Service Fabric name.", - "operationId": "CreateName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Create new name": { - "$ref": "examples/CreateName-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "201": { - "description": "A successful response means that the name has been created." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}": { - "get": { - "summary": "Returns whether the Service Fabric name exists.", - "description": "Returns whether the specified Service Fabric name exists.", - "operationId": "GetNameExistsInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the Service Fabric name exists." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes a Service Fabric name.", - "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.", - "operationId": "DeleteName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the Service Fabric name has been deleted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetSubNames": { - "get": { - "summary": "Enumerates all the Service Fabric names under a given name.", - "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. Querying a name that doesn't exist will fail.", - "operationId": "GetSubNameInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RecursiveOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get sub names": { - "$ref": "examples/GetSubNameInfoList-1.json" - }, - "Recursively search sub names": { - "$ref": "examples/GetSubNameInfoList-2.json" - }, - "Page using continuation token": { - "$ref": "examples/GetSubNameInfoList-3.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A paged list of Service Fabric names.", - "schema": { - "$ref": "#/definitions/PagedSubNameInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperties": { - "get": { - "summary": "Gets information on all Service Fabric properties under a given name.", - "description": "A Service Fabric name can have one or more named properties that stores custom information. This operation gets the information about these properties in a paged list. The information include name, value and metadata about each of the properties.", - "operationId": "GetPropertyInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/IncludeValuesOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get property info list": { - "$ref": "examples/GetPropertyInfoList-1.json" - }, - "Get property info list with values": { - "$ref": "examples/GetPropertyInfoList-2.json" - }, - "Page using continuation token": { - "$ref": "examples/GetPropertyInfoList-3.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A paged list of Service Fabric properties.", - "schema": { - "$ref": "#/definitions/PagedPropertyInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperty": { - "put": { - "summary": "Creates or updates a Service Fabric property.", - "description": "Creates or updates the specified Service Fabric property under a given name.", - "operationId": "PutProperty", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Put property": { - "$ref": "examples/PutProperty-1.json" - }, - "Put custom property": { - "$ref": "examples/PutProperty-2.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property has been created or updated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "summary": "Gets the specified Service Fabric property.", - "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.", - "operationId": "GetPropertyInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get property info": { - "$ref": "examples/GetPropertyInfo-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "Details on the Service Fabric property.", - "schema": { - "$ref": "#/definitions/PropertyInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes the specified Service Fabric property.", - "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.", - "operationId": "DeleteProperty", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property has been deleted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperties/$/SubmitBatch": { - "post": { - "summary": "Submits a property batch.", - "description": "Submits a batch of property operations. Either all or none of the operations will be committed.", - "operationId": "SubmitPropertyBatch", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Property batch operation": { - "$ref": "examples/SubmitPropertyBatch-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property batch succeeded.", - "schema": { - "$ref": "#/definitions/SuccessfulPropertyBatchInfo" - } - }, - "409": { - "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", - "schema": { - "$ref": "#/definitions/FailedPropertyBatchInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Cluster/Events": { - "get": { - "summary": "Gets all Cluster-related events.", - "description": "The response is list of ClusterEvent objects.", - "operationId": "GetClusterEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Cluster-related events": { - "$ref": "./examples/GetClusterEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ClusterEvent.", - "schema": { - "$ref": "#/definitions/ClusterEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Containers/Events": { - "get": { - "summary": "Gets all Containers-related events.", - "description": "The response is list of ContainerInstanceEvent objects.", - "operationId": "GetContainersEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "responses": { - "200": { - "description": "List of events objects with base type ContainerInstanceEvent.", - "schema": { - "$ref": "#/definitions/ContainerInstanceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Nodes/{nodeName}/$/Events": { - "get": { - "summary": "Gets a Node-related events.", - "description": "The response is list of NodeEvent objects.", - "operationId": "GetNodeEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Node-related events": { - "$ref": "./examples/GetNodeEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type NodeEvent.", - "schema": { - "$ref": "#/definitions/NodeEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Nodes/Events": { - "get": { - "summary": "Gets all Nodes-related Events.", - "description": "The response is list of NodeEvent objects.", - "operationId": "GetNodesEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Nodes-related events": { - "$ref": "./examples/GetNodesEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type NodeEvent.", - "schema": { - "$ref": "#/definitions/NodeEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Applications/{applicationId}/$/Events": { - "get": { - "summary": "Gets an Application-related events.", - "description": "The response is list of ApplicationEvent objects.", - "operationId": "GetApplicationEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Application-related events": { - "$ref": "./examples/GetApplicationEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ApplicationEvent.", - "schema": { - "$ref": "#/definitions/ApplicationEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Applications/Events": { - "get": { - "summary": "Gets all Applications-related events.", - "description": "The response is list of ApplicationEvent objects.", - "operationId": "GetApplicationsEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Applications-related events": { - "$ref": "./examples/GetApplicationsEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ApplicationEvent.", - "schema": { - "$ref": "#/definitions/ApplicationEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Services/{serviceId}/$/Events": { - "get": { - "summary": "Gets a Service-related events.", - "description": "The response is list of ServiceEvent objects.", - "operationId": "GetServiceEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Service-related events": { - "$ref": "./examples/GetServiceEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ServiceEvent.", - "schema": { - "$ref": "#/definitions/ServiceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Services/Events": { - "get": { - "summary": "Gets all Services-related events.", - "description": "The response is list of ServiceEvent objects.", - "operationId": "GetServicesEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Services-related events": { - "$ref": "./examples/GetServicesEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ServiceEvent.", - "schema": { - "$ref": "#/definitions/ServiceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Events": { - "get": { - "summary": "Gets a Partition-related events.", - "description": "The response is list of PartitionEvent objects.", - "operationId": "GetPartitionEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition-related events": { - "$ref": "./examples/GetPartitionEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type PartitionEvent.", - "schema": { - "$ref": "#/definitions/PartitionEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/Events": { - "get": { - "summary": "Gets all Partitions-related events.", - "description": "The response is list of PartitionEvent objects.", - "operationId": "GetPartitionsEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partitions-related events": { - "$ref": "./examples/GetPartitionsEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type PartitionEvent.", - "schema": { - "$ref": "#/definitions/PartitionEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": { - "get": { - "summary": "Gets a Partition Replica-related events.", - "description": "The response is list of ReplicaEvent objects.", - "operationId": "GetPartitionReplicaEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition Replica-related events": { - "$ref": "./examples/GetReplicaEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ReplicaEvent.", - "schema": { - "$ref": "#/definitions/ReplicaEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": { - "get": { - "summary": "Gets all Replicas-related events for a Partition.", - "description": "The response is list of ReplicaEvent objects.", - "operationId": "GetPartitionReplicasEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition Replicas-related events": { - "$ref": "./examples/GetReplicasEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ReplicaEvent.", - "schema": { - "$ref": "#/definitions/ReplicaEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": { - "get": { - "summary": "Gets all correlated events for a given event.", - "description": "The response is list of FabricEvents.", - "operationId": "GetCorrelatedEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventInstanceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Correlated events": { - "$ref": "./examples/GetCorrelatedEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type FabricEvent.", - "schema": { - "$ref": "#/definitions/EventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - } - }, - "definitions": { - "AadMetadata": { - "type": "object", - "description": "Azure Active Directory metadata used for secured connection to cluster.", - "properties": { - "authority": { - "type": "string", - "description": "The AAD authority url." - }, - "client": { - "type": "string", - "description": "The AAD client application Id." - }, - "cluster": { - "type": "string", - "description": "The AAD cluster application Id." - }, - "login": { - "type": "string", - "description": "The AAD login url." - }, - "redirect": { - "type": "string", - "description": "The client application redirect address." - }, - "tenant": { - "type": "string", - "description": "The AAD tenant Id." - } - } - }, - "AadMetadataObject": { - "type": "object", - "description": "Azure Active Directory metadata object used for secured connection to cluster.", - "properties": { - "type": { - "type": "string", - "description": "The client authentication method." - }, - "metadata": { - "$ref": "#/definitions/AadMetadata", - "description": "Azure Active Directory metadata used for secured connection to cluster." - } - } - }, - "AnalysisEventMetadata": { - "type": "object", - "description": "Metadata about an Analysis Event.", - "properties": { - "Delay": { - "type": "string", - "format": "duration", - "description": "The analysis delay." - }, - "Duration": { - "type": "string", - "format": "duration", - "description": "The duration of analysis." - } - } - }, - "ApplicationDefinitionKind": { - "type": "string", - "description": "The mechanism used to define a Service Fabric application.", - "enum": [ - "Invalid", - "ServiceFabricApplicationDescription", - "Compose" - ], - "x-ms-enum": { - "name": "ApplicationDefinitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535." - }, - { - "value": "ServiceFabricApplicationDescription", - "description": "Indicates the application is defined by a Service Fabric application description. The value is 0." - }, - { - "value": "Compose", - "description": "Indicates the application is defined by compose file(s). The value is 1." - } - ] - } - }, - "ApplicationEvent": { - "description": "Represents the base for all Application Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ApplicationEvent", - "properties": { - "ApplicationId": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - } - }, - "required": [ - "ApplicationId" - ] - } - ], - "x-ms-discriminator-value": "ApplicationEvent" - }, - "ApplicationEventList": { - "description": "A list of ApplicationEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationEvent" - } - }, - "ApplicationHealth": { - "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ApplicationHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthState" - }, - "description": "Service health states as found in the health store." - }, - "DeployedApplicationHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthState" - }, - "description": "Deployed application health states as found in the health store." - } - } - } - ] - }, - "ApplicationHealthEvaluation": { - "x-ms-discriminator-value": "Application", - "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationHealthEvaluation", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "ApplicationHealthPolicies": { - "type": "object", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.", - "properties": { - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster." - } - } - }, - "ApplicationHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.", - "default": 0 - }, - "DefaultServiceTypeHealthPolicy": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The health policy used by default to evaluate the health of a service type." - }, - "ServiceTypeHealthPolicyMap": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMap", - "description": "The map with service type health policy per service type name. The map is empty by default." - } - } - }, - "ApplicationHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthPolicyMapItem" - }, - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - }, - "ApplicationHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ApplicationHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "$ref": "#/definitions/ApplicationName", - "description": "The key of the application health policy map item. This is the name of the application." - }, - "Value": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application." - } - } - }, - "ApplicationHealthState": { - "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ApplicationHealthState", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ] - }, - "ApplicationHealthStateChunk": { - "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ApplicationHealthStateChunk", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "ServiceHealthStateChunks": { - "$ref": "#/definitions/ServiceHealthStateChunkList", - "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description." - }, - "DeployedApplicationHealthStateChunks": { - "$ref": "#/definitions/DeployedApplicationHealthStateChunkList", - "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "ApplicationHealthStateChunkList": { - "type": "object", - "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunkList" - }, - { - "type": "object", - "description": "ApplicationHealthStateChunkList", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthStateChunk" - }, - "description": "The list of application health state chunks that respect the input filters in the chunk query." - } - } - } - ] - }, - "ApplicationHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.", - "properties": { - "ApplicationNameFilter": { - "type": "string", - "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." - }, - "ApplicationTypeNameFilter": { - "type": "string", - "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "ServiceFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthStateFilter" - }, - "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name." - }, - "DeployedApplicationFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthStateFilter" - }, - "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node." - } - } - }, - "ApplicationId": { - "type": "string", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "ApplicationInfo": { - "type": "object", - "description": "Information about a Service Fabric application.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "Status": { - "$ref": "#/definitions/ApplicationStatus", - "description": "The status of the application." - }, - "Parameters": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "ApplicationDefinitionKind": { - "$ref": "#/definitions/ApplicationDefinitionKind", - "description": "The mechanism used to define a Service Fabric application." - } - } - }, - "ApplicationLoadInfo": { - "type": "object", - "description": "Load Information about a Service Fabric application.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "MinimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero." - }, - "MaximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero." - }, - "NodeCount": { - "type": "integer", - "format": "int64", - "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero." - }, - "ApplicationLoadMetricInformation": { - "$ref": "#/definitions/ApplicationMetricDescriptionList", - "description": "List of application capacity metric description." - } - } - }, - "ApplicationName": { - "type": "string", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ApplicationNameInfo": { - "type": "object", - "description": "Information about the application name.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - }, - "ApplicationPackageCleanupPolicy": { - "type": "string", - "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.", - "enum": [ - "Invalid", - "Default", - "Automatic", - "Manual" - ], - "x-ms-enum": { - "name": "ApplicationPackageCleanupPolicy", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero." - }, - { - "value": "Default", - "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1." - }, - { - "value": "Automatic", - "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2." - }, - { - "value": "Manual", - "description": "Indicates that the user has to explicitly clean up the application package. The value is 3." - } - ] - } - }, - "ApplicationParameter": { - "type": "object", - "description": "Describes an application parameter override to be applied when creating or upgrading an application.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The name of the parameter." - }, - "Value": { - "type": "string", - "description": "The value of the parameter." - } - } - }, - "ApplicationParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "ApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "Applications", - "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of applications from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ApplicationStatus": { - "type": "string", - "description": "The status of the application.", - "enum": [ - "Invalid", - "Ready", - "Upgrading", - "Creating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ready", - "description": "Indicates the application status is ready. The value is 1." - }, - { - "value": "Upgrading", - "description": "Indicates the application status is upgrading. The value is 2." - }, - { - "value": "Creating", - "description": "Indicates the application status is creating. The value is 3." - }, - { - "value": "Deleting", - "description": "Indicates the application status is deleting. The value is 4." - }, - { - "value": "Failed", - "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5." - } - ] - } - }, - "ApplicationTypeApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "ApplicationTypeApplications", - "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationTypeApplicationsHealthEvaluation", - "properties": { - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of applications of the application type found in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health." - } - } - } - ] - }, - "ApplicationTypeDefinitionKind": { - "type": "string", - "description": "The mechanism used to define a Service Fabric application type.", - "enum": [ - "Invalid", - "ServiceFabricApplicationPackage", - "Compose" - ], - "x-ms-enum": { - "name": "ApplicationTypeDefinitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0." - }, - { - "value": "ServiceFabricApplicationPackage", - "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1." - }, - { - "value": "Compose", - "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2." - } - ] - } - }, - "ApplicationTypeHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem" - }, - "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." - }, - "ApplicationTypeHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ApplicationTypeHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key of the application type health policy map item. This is the name of the application type." - }, - "Value": { - "type": "integer", - "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100." - } - } - }, - "ApplicationTypeInfo": { - "type": "object", - "description": "Information about an application type.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "Version": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "DefaultParameterList": { - "$ref": "#/definitions/ApplicationTypeParameterList", - "description": "List of application type parameters that can be overridden when creating or updating the application." - }, - "Status": { - "$ref": "#/definitions/ApplicationTypeStatus", - "description": "The status of the application type." - }, - "StatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the application type." - }, - "ApplicationTypeDefinitionKind": { - "$ref": "#/definitions/ApplicationTypeDefinitionKind", - "description": "The mechanism used to define a Service Fabric application type." - } - } - }, - "PagedApplicationTypeInfoList": { - "type": "object", - "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of application type information.", - "items": { - "$ref": "#/definitions/ApplicationTypeInfo" - } - } - } - }, - "ApplicationTypeManifest": { - "type": "object", - "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.", - "properties": { - "Manifest": { - "type": "string", - "description": "The XML manifest as a string." - } - } - }, - "ApplicationTypeName": { - "type": "string", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application type parameters that can be overridden when creating or updating the application." - }, - "ApplicationTypeStatus": { - "type": "string", - "description": "The status of the application type.", - "enum": [ - "Invalid", - "Provisioning", - "Available", - "Unprovisioning", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationTypeStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Provisioning", - "description": "Indicates that the application type is being provisioned in the cluster. The value is 1." - }, - { - "value": "Available", - "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2." - }, - { - "value": "Unprovisioning", - "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3." - }, - { - "value": "Failed", - "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4." - } - ] - } - }, - "ApplicationUnhealthyEvaluations": { - "description": "List of health evaluations that resulted in the current aggregated health state.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvaluationWrapper" - } - }, - "ApplicationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.", - "properties": { - "Name": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "Parameters": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - } - }, - "required": [ - "Name", - "TargetApplicationTypeVersion", - "UpgradeKind", - "Parameters" - ] - }, - "ApplicationUpgradeProgressInfo": { - "type": "object", - "description": "Describes the parameters for an application upgrade.", - "properties": { - "Name": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "UpgradeDomains": { - "$ref": "#/definitions/UpgradeDomainInfoList", - "description": "List of upgrade domains and their statuses." - }, - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "NextUpgradeDomain": { - "$ref": "#/definitions/NextUpgradeDomain", - "description": "The name of the next upgrade domain to be processed." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeDescription": { - "$ref": "#/definitions/ApplicationUpgradeDescription", - "description": "Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription." - }, - "UpgradeDurationInMilliseconds": { - "type": "string", - "description": "The estimated total amount of time spent processing the overall upgrade." - }, - "UpgradeDomainDurationInMilliseconds": { - "type": "string", - "description": "The estimated total amount of time spent processing the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade started." - }, - "FailureTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", - "description": "Information about the upgrade domain progress at the time of upgrade failure." - }, - "UpgradeStatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the pending upgrade." - } - } - }, - "ByteArray": { - "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.", - "type": "array", - "items": { - "type": "integer" - } - }, - "ClusterConfiguration": { - "type": "object", - "description": "Information about the standalone cluster configuration.", - "properties": { - "ClusterConfiguration": { - "type": "string", - "description": "The contents of the cluster configuration file." - } - } - }, - "ClusterEvent": { - "description": "Represents the base for all Cluster Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ClusterEvent" - } - ], - "x-ms-discriminator-value": "ClusterEvent" - }, - "ClusterEventList": { - "description": "A list of ClusterEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ClusterEvent" - } - }, - "ClusterHealth": { - "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ClusterHealth", - "properties": { - "NodeHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthState" - }, - "description": "Cluster node health states as found in the health store." - }, - "ApplicationHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthState" - }, - "description": "Cluster application health states as found in the health store." - } - } - } - ] - }, - "ClusterHealthChunk": { - "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.", - "type": "object", - "properties": { - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies." - }, - "NodeHealthStateChunks": { - "$ref": "#/definitions/NodeHealthStateChunkList", - "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description." - }, - "ApplicationHealthStateChunks": { - "$ref": "#/definitions/ApplicationHealthStateChunkList", - "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description." - } - } - }, - "ClusterHealthChunkQueryDescription": { - "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.", - "properties": { - "NodeFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthStateFilter" - }, - "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName." - }, - "ApplicationFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthStateFilter" - }, - "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "ApplicationHealthPolicies": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "ClusterHealthPolicies": { - "description": "Health policies to evaluate cluster health.", - "properties": { - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - } - } - }, - "ClusterHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.", - "default": 0 - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.", - "default": 0 - }, - "ApplicationTypeHealthPolicyMap": { - "$ref": "#/definitions/ApplicationTypeHealthPolicyMap", - "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." - } - } - }, - "ClusterManifest": { - "type": "object", - "description": "Information about the cluster manifest.", - "properties": { - "Manifest": { - "type": "string", - "description": "The contents of the cluster manifest file." - } - } - }, - "ContainerApiRequestBody": { - "type": "object", - "description": "parameters for making container API call.", - "properties": { - "HttpVerb": { - "type": "string", - "description": "HTTP verb of container REST API, defaults to \"GET\"" - }, - "UriPath": { - "type": "string", - "description": "URI path of container REST API" - }, - "Content-Type": { - "type": "string", - "description": "Content type of container REST API request, defaults to \"application/json\"" - }, - "Body": { - "type": "string", - "description": "HTTP request body of container REST API" - } - }, - "required": [ - "UriPath" - ] - }, - "ContainerApiResponse": { - "type": "object", - "description": "Response body that wraps container API result.", - "properties": { - "ContainerApiResult": { - "$ref": "#/definitions/ContainerApiResult", - "description": "Container API result." - } - }, - "required": [ - "ContainerApiResult" - ] - }, - "ContainerApiResult": { - "type": "object", - "description": "Container API result.", - "properties": { - "Status": { - "type": "integer", - "description": "HTTP status code returned by the target container API" - }, - "Content-Type": { - "type": "string", - "description": "HTTP content type" - }, - "Content-Encoding": { - "type": "string", - "description": "HTTP content encoding" - }, - "Body": { - "type": "string", - "description": "container API result body" - } - }, - "required": [ - "Status" - ] - }, - "ContainerInstanceEvent": { - "description": "Represents the base for all Container Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ContainerInstanceEvent" - } - ], - "x-ms-discriminator-value": "ContainerInstanceEvent" - }, - "ContainerInstanceEventList": { - "description": "A list of ContainerInstanceEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerInstanceEvent" - } - }, - "ContinuationToken": { - "type": "string", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "CurrentUpgradeDomainProgressInfo": { - "type": "object", - "description": "Information about the current in-progress upgrade domain.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "CurrentUpgradeDomainDuration": { - "type": "string", - "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "DeactivationIntentDescription": { - "description": "Describes the intent or reason for deactivating the node.", - "properties": { - "DeactivationIntent": { - "type": "string", - "description": "Describes the intent or reason for deactivating the node. The possible values are following.", - "enum": [ - "Pause", - "Restart", - "RemoveData" - ], - "x-ms-enum": { - "name": "DeactivationIntent", - "modelAsString": true, - "values": [ - { - "value": "Pause", - "description": "Indicates that the node should be paused. The value is 1." - }, - { - "value": "Restart", - "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2." - }, - { - "value": "RemoveData", - "description": "Indicates the intent is for the node to remove data. The value is 3." - } - ] - } - } - } - }, - "DeltaNodesCheckHealthEvaluation": { - "x-ms-discriminator-value": "DeltaNodesCheck", - "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeltaNodesCheckHealthEvaluation", - "properties": { - "BaselineErrorCount": { - "type": "integer", - "format": "int64", - "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." - }, - "BaselineTotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the health store at the beginning of the cluster upgrade." - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedApplicationHealth": { - "description": "Information about the health of an application deployed on a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "DeployedApplicationHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "Name of the application deployed on the node whose health information is described by this object." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where this application is deployed." - }, - "DeployedServicePackageHealthStates": { - "$ref": "#/definitions/DeployedServicePackageHealthStateList", - "description": "Deployed service package health states for the current deployed application as found in the health store." - } - } - } - ] - }, - "DeployedApplicationHealthEvaluation": { - "x-ms-discriminator-value": "DeployedApplication", - "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedApplicationHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where the application is deployed to." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "DeployedApplicationHealthState": { - "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "DeployedApplicationHealthState", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node on which the service package is deployed." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ] - }, - "DeployedApplicationHealthStateChunk": { - "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "DeployedApplicationHealthStateChunk", - "properties": { - "NodeName": { - "type": "string", - "description": "The name of node where the application is deployed." - }, - "DeployedServicePackageHealthStateChunks": { - "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList", - "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "DeployedApplicationHealthStateChunkList": { - "type": "object", - "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthStateChunk" - }, - "description": "The list of deployed application health state chunks that respect the input filters in the chunk query." - } - } - }, - "DeployedApplicationHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.", - "properties": { - "NodeNameFilter": { - "type": "string", - "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "DeployedServicePackageFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthStateFilter" - }, - "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node." - } - } - }, - "DeployedApplicationInfo": { - "type": "object", - "description": "Information about application deployed on the node.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "Status": { - "$ref": "#/definitions/DeployedApplicationStatus", - "description": "The status of the application deployed on the node. Following are the possible values." - }, - "WorkDirectory": { - "type": "string", - "description": "The work directory of the application on the node. The work directory can be used to store application data." - }, - "LogDirectory": { - "type": "string", - "description": "The log directory of the application on the node. The log directory can be used to store application logs." - }, - "TempDirectory": { - "type": "string", - "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "DeployedApplicationInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationInfo" - }, - "description": "List of deployed application information." - }, - "DeployedApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "DeployedApplications", - "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedApplicationsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of deployed applications of the application in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedApplicationStatus": { - "type": "string", - "description": "The status of the application deployed on the node. Following are the possible values.", - "enum": [ - "Invalid", - "Downloading", - "Activating", - "Active", - "Upgrading", - "Deactivating" - ], - "x-ms-enum": { - "name": "DeployedApplicationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Downloading", - "description": "Indicates that the package is downloading from the ImageStore. The value is 1." - }, - { - "value": "Activating", - "description": "Indicates that the package is activating. The value is 2." - }, - { - "value": "Active", - "description": "Indicates that the package is active. The value is 3." - }, - { - "value": "Upgrading", - "description": "Indicates that the package is upgrading. The value is 4." - }, - { - "value": "Deactivating", - "description": "Indicates that the package is deactivating. The value is 5." - } - ] - } - }, - "DeployedServicePackageHealth": { - "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "DeployedServicePackageHealth", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "Name of the service manifest." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where this service package is deployed." - } - } - } - ] - }, - "DeployedServicePackageHealthEvaluation": { - "x-ms-discriminator-value": "DeployedServicePackage", - "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "DeployedServicePackageHealthState": { - "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthState", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node on which the service package is deployed." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "Name of the manifest describing the service package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - } - ] - }, - "DeployedServicePackageHealthStateChunk": { - "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthStateChunk", - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - } - ] - }, - "DeployedServicePackageHealthStateChunkList": { - "type": "object", - "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthStateChunk" - }, - "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query." - } - } - }, - "DeployedServicePackageHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.", - "properties": { - "ServiceManifestNameFilter": { - "type": "string", - "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "ServicePackageActivationIdFilter": { - "type": "string", - "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "DeployedServicePackageHealthStateList": { - "description": "List of health states for a service package deployed on a Service Fabric node.", - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthState" - } - }, - "DeployedServicePackagesHealthEvaluation": { - "x-ms-discriminator-value": "DeployedServicePackages", - "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedServicePackagesHealthEvaluation", - "properties": { - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of deployed service packages of the deployed application in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedServiceReplicaInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service replica deployed on a node.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package that hosts this replica." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "ReplicaStatus": { - "$ref": "#/definitions/ReplicaStatus", - "description": "The status of a replica of a service." - }, - "Address": { - "type": "string", - "description": "The last address returned by the replica in Open or ChangeRole." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "HostProcessId": { - "type": "string", - "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel." - } - } - }, - "DeployedServiceReplicaInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - "description": "List of deployed service replica information." - }, - "DeployedStatefulServiceReplicaInfo": { - "description": "Information about a stateful service replica deployed on a node.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - { - "type": "object", - "description": "DeployedStatefulServiceReplicaInfo", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - }, - "ReconfigurationInformation": { - "$ref": "#/definitions/ReconfigurationInformation", - "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time." - } - } - } - ] - }, - "DeployedStatelessServiceInstanceInfo": { - "description": "Information about a stateless service instance deployed on a node.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - { - "type": "object", - "description": "DeployedStatelessServiceInstanceInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "EntityHealth": { - "type": "object", - "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.", - "properties": { - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy." - }, - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - }, - "description": "The list of health events reported on the entity." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager." - }, - "HealthStatistics": { - "$ref": "#/definitions/HealthStatistics", - "description": "Shows the health statistics for all children types of the queried entity." - } - } - }, - "EntityHealthState": { - "type": "object", - "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.", - "properties": { - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "EntityHealthStateChunk": { - "type": "object", - "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.", - "properties": { - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "EntityHealthStateChunkList": { - "type": "object", - "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.", - "properties": { - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description." - } - } - }, - "Epoch": { - "type": "object", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", - "properties": { - "ConfigurationVersion": { - "type": "string", - "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." - }, - "DataLossVersion": { - "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." - } - } - }, - "BackupEpoch": { - "type": "object", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", - "properties": { - "ConfigurationNumber": { - "type": "string", - "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." - }, - "DataLossNumber": { - "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." - } - } - }, - "EventHealthEvaluation": { - "x-ms-discriminator-value": "Event", - "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "EventHealthEvaluation", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity." - }, - "UnhealthyEvent": { - "$ref": "#/definitions/HealthEvent", - "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager." - } - } - } - ] - }, - "EventList": { - "description": "A list of FabricEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/FabricEvent" - } - }, - "FabricCodeVersionInfo": { - "type": "object", - "description": "Information about a Service Fabric code version.", - "properties": { - "CodeVersion": { - "description": "The product version of Service Fabric.", - "type": "string" - } - } - }, - "FabricCodeVersionInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/FabricCodeVersionInfo" - }, - "description": "List of all Service Fabric code versions." - }, - "FabricConfigVersionInfo": { - "type": "object", - "description": "Information about a Service Fabric config version.", - "properties": { - "ConfigVersion": { - "description": "The config version of Service Fabric.", - "type": "string" - } - } - }, - "FabricConfigVersionInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/FabricConfigVersionInfo" - }, - "description": "List of all Service Fabric config versions." - }, - "FabricError": { - "type": "object", - "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.", - "properties": { - "Error": { - "$ref": "#/definitions/FabricErrorError", - "description": "Error object containing error code and error message." - } - }, - "required": [ - "Error" - ] - }, - "FabricErrorError": { - "type": "object", - "description": "Error object containing error code and error message.", - "properties": { - "Code": { - "$ref": "#/definitions/FabricErrorCodes", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" - }, - "Message": { - "type": "string", - "description": "Error message." - } - }, - "required": [ - "Code" - ] - }, - "FabricErrorCodes": { - "type": "string", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", - "enum": [ - "FABRIC_E_INVALID_PARTITION_KEY", - "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", - "FABRIC_E_INVALID_ADDRESS", - "FABRIC_E_APPLICATION_NOT_UPGRADING", - "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR", - "FABRIC_E_FABRIC_NOT_UPGRADING", - "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR", - "FABRIC_E_INVALID_CONFIGURATION", - "FABRIC_E_INVALID_NAME_URI", - "FABRIC_E_PATH_TOO_LONG", - "FABRIC_E_KEY_TOO_LARGE", - "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED", - "FABRIC_E_INVALID_ATOMIC_GROUP", - "FABRIC_E_VALUE_EMPTY", - "FABRIC_E_NODE_NOT_FOUND", - "FABRIC_E_APPLICATION_TYPE_NOT_FOUND", - "FABRIC_E_APPLICATION_NOT_FOUND", - "FABRIC_E_SERVICE_TYPE_NOT_FOUND", - "FABRIC_E_SERVICE_DOES_NOT_EXIST", - "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND", - "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND", - "FABRIC_E_PARTITION_NOT_FOUND", - "FABRIC_E_REPLICA_DOES_NOT_EXIST", - "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST", - "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND", - "FABRIC_E_DIRECTORY_NOT_FOUND", - "FABRIC_E_FABRIC_VERSION_NOT_FOUND", - "FABRIC_E_FILE_NOT_FOUND", - "FABRIC_E_NAME_DOES_NOT_EXIST", - "FABRIC_E_PROPERTY_DOES_NOT_EXIST", - "FABRIC_E_ENUMERATION_COMPLETED", - "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND", - "FABRIC_E_KEY_NOT_FOUND", - "FABRIC_E_HEALTH_ENTITY_NOT_FOUND", - "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION", - "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS", - "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS", - "FABRIC_E_SERVICE_ALREADY_EXISTS", - "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_TYPE_IN_USE", - "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION", - "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS", - "FABRIC_E_FABRIC_VERSION_IN_USE", - "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS", - "FABRIC_E_NAME_ALREADY_EXISTS", - "FABRIC_E_NAME_NOT_EMPTY", - "FABRIC_E_PROPERTY_CHECK_FAILED", - "FABRIC_E_SERVICE_METADATA_MISMATCH", - "FABRIC_E_SERVICE_TYPE_MISMATCH", - "FABRIC_E_HEALTH_STALE_REPORT", - "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED", - "FABRIC_E_NODE_HAS_NOT_STOPPED_YET", - "FABRIC_E_INSTANCE_ID_MISMATCH", - "FABRIC_E_VALUE_TOO_LARGE", - "FABRIC_E_NO_WRITE_QUORUM", - "FABRIC_E_NOT_PRIMARY", - "FABRIC_E_NOT_READY", - "FABRIC_E_RECONFIGURATION_PENDING", - "FABRIC_E_SERVICE_OFFLINE", - "E_ABORT", - "FABRIC_E_COMMUNICATION_ERROR", - "FABRIC_E_OPERATION_NOT_COMPLETE", - "FABRIC_E_TIMEOUT", - "FABRIC_E_NODE_IS_UP", - "E_FAIL", - "FABRIC_E_BACKUP_IS_ENABLED", - "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH", - "FABRIC_E_INVALID_FOR_STATELESS_SERVICES", - "FABRIC_E_BACKUP_NOT_ENABLED", - "FABRIC_E_BACKUP_POLICY_NOT_EXISTING", - "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING", - "FABRIC_E_BACKUP_IN_PROGRESS", - "FABRIC_E_RESTORE_IN_PROGRESS", - "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING", - "FABRIC_E_INVALID_SERVICE_SCALING_POLICY", - "E_INVALIDARG" - ], - "x-ms-enum": { - "name": "FabricErrorCodes", - "modelAsString": true, - "values": [ - { - "value": "FABRIC_E_INVALID_PARTITION_KEY" - }, - { - "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_INVALID_ADDRESS" - }, - { - "value": "FABRIC_E_APPLICATION_NOT_UPGRADING" - }, - { - "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_FABRIC_NOT_UPGRADING" - }, - { - "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_INVALID_CONFIGURATION" - }, - { - "value": "FABRIC_E_INVALID_NAME_URI" - }, - { - "value": "FABRIC_E_PATH_TOO_LONG" - }, - { - "value": "FABRIC_E_KEY_TOO_LARGE" - }, - { - "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" - }, - { - "value": "FABRIC_E_INVALID_ATOMIC_GROUP" - }, - { - "value": "FABRIC_E_VALUE_EMPTY" - }, - { - "value": "FABRIC_E_NODE_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_NOT_FOUND" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND" - }, - { - "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" - }, - { - "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" - }, - { - "value": "FABRIC_E_PARTITION_NOT_FOUND" - }, - { - "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" - }, - { - "value": "FABRIC_E_DIRECTORY_NOT_FOUND" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND" - }, - { - "value": "FABRIC_E_FILE_NOT_FOUND" - }, - { - "value": "FABRIC_E_NAME_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_ENUMERATION_COMPLETED" - }, - { - "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" - }, - { - "value": "FABRIC_E_KEY_NOT_FOUND" - }, - { - "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" - }, - { - "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_SERVICE_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_IN_USE" - }, - { - "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_IN_USE" - }, - { - "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_NAME_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_NAME_NOT_EMPTY" - }, - { - "value": "FABRIC_E_PROPERTY_CHECK_FAILED" - }, - { - "value": "FABRIC_E_SERVICE_METADATA_MISMATCH" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_MISMATCH" - }, - { - "value": "FABRIC_E_HEALTH_STALE_REPORT" - }, - { - "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" - }, - { - "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" - }, - { - "value": "FABRIC_E_INSTANCE_ID_MISMATCH" - }, - { - "value": "FABRIC_E_VALUE_TOO_LARGE" - }, - { - "value": "FABRIC_E_NO_WRITE_QUORUM" - }, - { - "value": "FABRIC_E_NOT_PRIMARY" - }, - { - "value": "FABRIC_E_NOT_READY" - }, - { - "value": "FABRIC_E_RECONFIGURATION_PENDING" - }, - { - "value": "FABRIC_E_SERVICE_OFFLINE" - }, - { - "value": "E_ABORT" - }, - { - "value": "FABRIC_E_COMMUNICATION_ERROR" - }, - { - "value": "FABRIC_E_OPERATION_NOT_COMPLETE" - }, - { - "value": "FABRIC_E_TIMEOUT" - }, - { - "value": "FABRIC_E_NODE_IS_UP" - }, - { - "value": "E_FAIL" - }, - { - "value": "FABRIC_E_BACKUP_IS_ENABLED" - }, - { - "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" - }, - { - "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" - }, - { - "value": "FABRIC_E_BACKUP_NOT_ENABLED" - }, - { - "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" - }, - { - "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" - }, - { - "value": "FABRIC_E_BACKUP_IN_PROGRESS" - }, - { - "value": "FABRIC_E_RESTORE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" - }, - { - "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" - }, - { - "value": "E_INVALIDARG" - } - ] - } - }, - "FabricEvent": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the base for all Fabric Events.", - "properties": { - "Kind": { - "$ref": "#/definitions/FabricEventKind", - "description": "The kind of FabricEvent." - }, - "EventInstanceId": { - "type": "string", - "format": "uuid", - "description": "The identifier for the FabricEvent instance." - }, - "TimeStamp": { - "type": "string", - "format": "date-time", - "description": "The time event was logged." - }, - "HasCorrelatedEvents": { - "type": "boolean", - "description": "Shows there is existing related events available." - } - }, - "required": [ - "Kind", - "EventInstanceId", - "TimeStamp" - ] - }, - "FabricEventKind": { - "type": "string", - "description": "The kind of FabricEvent.", - "enum": [ - "ClusterEvent", - "ContainerInstanceEvent", - "NodeEvent", - "ApplicationEvent", - "ServiceEvent", - "PartitionEvent", - "ReplicaEvent", - "PartitionAnalysisEvent", - "ApplicationCreated", - "ApplicationDeleted", - "ApplicationHealthReportCreated", - "ApplicationHealthReportExpired", - "ApplicationUpgradeComplete", - "ApplicationUpgradeDomainComplete", - "ApplicationUpgradeRollbackComplete", - "ApplicationUpgradeRollbackStart", - "ApplicationUpgradeStart", - "DeployedApplicationHealthReportCreated", - "DeployedApplicationHealthReportExpired", - "ProcessDeactivated", - "ContainerDeactivated", - "NodeAborted", - "NodeAborting", - "NodeAdded", - "NodeClose", - "NodeClosing", - "NodeDeactivateComplete", - "NodeDeactivateStart", - "NodeDown", - "NodeHealthReportCreated", - "NodeHealthReportExpired", - "NodeOpenedSuccess", - "NodeOpenFailed", - "NodeOpening", - "NodeRemoved", - "NodeUp", - "PartitionHealthReportCreated", - "PartitionHealthReportExpired", - "PartitionReconfigurationCompleted", - "PartitionPrimaryMoveAnalysis", - "ServiceCreated", - "ServiceDeleted", - "ServiceHealthReportCreated", - "ServiceHealthReportExpired", - "DeployedServiceHealthReportCreated", - "DeployedServiceHealthReportExpired", - "StatefulReplicaHealthReportCreated", - "StatefulReplicaHealthReportExpired", - "StatelessReplicaHealthReportCreated", - "StatelessReplicaHealthReportExpired", - "ClusterHealthReportCreated", - "ClusterHealthReportExpired", - "ClusterUpgradeComplete", - "ClusterUpgradeDomainComplete", - "ClusterUpgradeRollbackComplete", - "ClusterUpgradeRollbackStart", - "ClusterUpgradeStart", - "ChaosStopped", - "ChaosStarted", - "ChaosRestartNodeFaultCompleted", - "ChaosRestartCodePackageFaultScheduled", - "ChaosRestartCodePackageFaultCompleted", - "ChaosRemoveReplicaFaultScheduled", - "ChaosRemoveReplicaFaultCompleted", - "ChaosMoveSecondaryFaultScheduled", - "ChaosMovePrimaryFaultScheduled", - "ChaosRestartReplicaFaultScheduled", - "ChaosRestartNodeFaultScheduled" - ], - "x-ms-enum": { - "name": "FabricEventKind", - "modelAsString": true, - "values": [ - { - "value": "ClusterEvent" - }, - { - "value": "ContainerInstanceEvent" - }, - { - "value": "NodeEvent" - }, - { - "value": "ApplicationEvent" - }, - { - "value": "ServiceEvent" - }, - { - "value": "PartitionEvent" - }, - { - "value": "ReplicaEvent" - }, - { - "value": "PartitionAnalysisEvent" - }, - { - "value": "ApplicationCreated" - }, - { - "value": "ApplicationDeleted" - }, - { - "value": "ApplicationHealthReportCreated" - }, - { - "value": "ApplicationHealthReportExpired" - }, - { - "value": "ApplicationUpgradeComplete" - }, - { - "value": "ApplicationUpgradeDomainComplete" - }, - { - "value": "ApplicationUpgradeRollbackComplete" - }, - { - "value": "ApplicationUpgradeRollbackStart" - }, - { - "value": "ApplicationUpgradeStart" - }, - { - "value": "DeployedApplicationHealthReportCreated" - }, - { - "value": "DeployedApplicationHealthReportExpired" - }, - { - "value": "ProcessDeactivated" - }, - { - "value": "ContainerDeactivated" - }, - { - "value": "NodeAborted" - }, - { - "value": "NodeAborting" - }, - { - "value": "NodeAdded" - }, - { - "value": "NodeClose" - }, - { - "value": "NodeClosing" - }, - { - "value": "NodeDeactivateComplete" - }, - { - "value": "NodeDeactivateStart" - }, - { - "value": "NodeDown" - }, - { - "value": "NodeHealthReportCreated" - }, - { - "value": "NodeHealthReportExpired" - }, - { - "value": "NodeOpenedSuccess" - }, - { - "value": "NodeOpenFailed" - }, - { - "value": "NodeOpening" - }, - { - "value": "NodeRemoved" - }, - { - "value": "NodeUp" - }, - { - "value": "PartitionHealthReportCreated" - }, - { - "value": "PartitionHealthReportExpired" - }, - { - "value": "PartitionReconfigurationCompleted" - }, - { - "value": "PartitionPrimaryMoveAnalysis" - }, - { - "value": "ServiceCreated" - }, - { - "value": "ServiceDeleted" - }, - { - "value": "ServiceHealthReportCreated" - }, - { - "value": "ServiceHealthReportExpired" - }, - { - "value": "DeployedServiceHealthReportCreated" - }, - { - "value": "DeployedServiceHealthReportExpired" - }, - { - "value": "StatefulReplicaHealthReportCreated" - }, - { - "value": "StatefulReplicaHealthReportExpired" - }, - { - "value": "StatelessReplicaHealthReportCreated" - }, - { - "value": "StatelessReplicaHealthReportExpired" - }, - { - "value": "ClusterHealthReportCreated" - }, - { - "value": "ClusterHealthReportExpired" - }, - { - "value": "ClusterUpgradeComplete" - }, - { - "value": "ClusterUpgradeDomainComplete" - }, - { - "value": "ClusterUpgradeRollbackComplete" - }, - { - "value": "ClusterUpgradeRollbackStart" - }, - { - "value": "ClusterUpgradeStart" - }, - { - "value": "ChaosStopped" - }, - { - "value": "ChaosStarted" - }, - { - "value": "ChaosRestartNodeFaultCompleted" - }, - { - "value": "ChaosRestartCodePackageFaultScheduled" - }, - { - "value": "ChaosRestartCodePackageFaultCompleted" - }, - { - "value": "ChaosRemoveReplicaFaultScheduled" - }, - { - "value": "ChaosRemoveReplicaFaultCompleted" - }, - { - "value": "ChaosMoveSecondaryFaultScheduled" - }, - { - "value": "ChaosMovePrimaryFaultScheduled" - }, - { - "value": "ChaosRestartReplicaFaultScheduled" - }, - { - "value": "ChaosRestartNodeFaultScheduled" - } - ] - } - }, - "ClusterConfigurationUpgradeStatusInfo": { - "type": "object", - "description": "Information about a standalone cluster configuration upgrade status.", - "properties": { - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "ProgressStatus": { - "type": "integer", - "description": "The cluster manifest version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster configuration version." - }, - "Details": { - "type": "string", - "description": "The cluster upgrade status details." - } - } - }, - "FailureAction": { - "type": "string", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", - "enum": [ - "Invalid", - "Rollback", - "Manual" - ], - "x-ms-enum": { - "name": "FailureAction", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rollback", - "description": "The upgrade will start rolling back automatically. The value is 1" - }, - { - "value": "Manual", - "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2" - } - ] - } - }, - "FailureReason": { - "type": "string", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed.", - "enum": [ - "None", - "Interrupted", - "HealthCheck", - "UpgradeDomainTimeout", - "OverallUpgradeTimeout" - ], - "x-ms-enum": { - "name": "FailureReason", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Interrupted", - "description": "There was an external request to rollback the upgrade. The value is 1" - }, - { - "value": "HealthCheck", - "description": "The upgrade failed due to health policy violations. The value is 2" - }, - { - "value": "UpgradeDomainTimeout", - "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3" - }, - { - "value": "OverallUpgradeTimeout", - "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4" - } - ] - } - }, - "FailureUpgradeDomainProgressInfo": { - "type": "object", - "description": "Information about the upgrade domain progress at the time of upgrade failure.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "ForceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", - "default": false - }, - "HealthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H10M0S" - }, - "HealthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "HealthCheckWaitDuration": { - "type": "string", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "0" - }, - "HealthEvaluation": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.", - "properties": { - "Kind": { - "$ref": "#/definitions/HealthEvaluationKind", - "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values." - }, - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "Description": { - "type": "string", - "description": "Description of the health evaluation, which represents a summary of the evaluation process." - } - }, - "required": [ - "Kind" - ] - }, - "HealthEvaluationKind": { - "type": "string", - "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.", - "enum": [ - "Invalid", - "Event", - "Replicas", - "Partitions", - "DeployedServicePackages", - "DeployedApplications", - "Services", - "Nodes", - "Applications", - "SystemApplication", - "UpgradeDomainDeployedApplications", - "UpgradeDomainNodes", - "Replica", - "Partition", - "DeployedServicePackage", - "DeployedApplication", - "Service", - "Node", - "Application", - "DeltaNodesCheck", - "UpgradeDomainDeltaNodesCheck", - "ApplicationTypeApplications" - ], - "x-ms-enum": { - "name": "HealthEvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the health evaluation is invalid. The value is zero." - }, - { - "value": "Event", - "description": "Indicates that the health evaluation is for a health event. The value is 1." - }, - { - "value": "Replicas", - "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2." - }, - { - "value": "Partitions", - "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3." - }, - { - "value": "DeployedServicePackages", - "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4." - }, - { - "value": "DeployedApplications", - "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5." - }, - { - "value": "Services", - "description": "Indicates that the health evaluation is for services of an application. The value is 6." - }, - { - "value": "Nodes", - "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7." - }, - { - "value": "Applications", - "description": "Indicates that the health evaluation is for the cluster applications. The value is 8." - }, - { - "value": "SystemApplication", - "description": "Indicates that the health evaluation is for the system application. The value is 9." - }, - { - "value": "UpgradeDomainDeployedApplications", - "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10." - }, - { - "value": "UpgradeDomainNodes", - "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11." - }, - { - "value": "Replica", - "description": "Indicates that the health evaluation is for a replica. The value is 13." - }, - { - "value": "Partition", - "description": "Indicates that the health evaluation is for a partition. The value is 14." - }, - { - "value": "DeployedServicePackage", - "description": "Indicates that the health evaluation is for a deployed service package. The value is 16." - }, - { - "value": "DeployedApplication", - "description": "Indicates that the health evaluation is for a deployed application. The value is 17." - }, - { - "value": "Service", - "description": "Indicates that the health evaluation is for a service. The value is 15." - }, - { - "value": "Node", - "description": "Indicates that the health evaluation is for a node. The value is 12." - }, - { - "value": "Application", - "description": "Indicates that the health evaluation is for an application. The value is 18." - }, - { - "value": "DeltaNodesCheck", - "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19." - }, - { - "value": "UpgradeDomainDeltaNodesCheck", - "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20." - }, - { - "value": "ApplicationTypeApplications", - "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21." - } - ] - } - }, - "HealthEvaluationWrapper": { - "type": "object", - "description": "Wrapper object for health evaluation.", - "properties": { - "HealthEvaluation": { - "$ref": "#/definitions/HealthEvaluation", - "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity." - } - } - }, - "HealthEvent": { - "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.", - "allOf": [ - { - "$ref": "#/definitions/HealthInformation" - }, - { - "type": "object", - "description": "HealthEvent", - "properties": { - "IsExpired": { - "type": "boolean", - "description": "Returns true if the health event is expired, otherwise false." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The date and time when the health report was sent by the source." - }, - "LastModifiedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The date and time when the health report was last modified by the health store." - }, - "LastOkTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time." - }, - "LastWarningTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time." - }, - "LastErrorTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time." - } - } - } - ] - }, - "HealthInformation": { - "type": "object", - "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.", - "required": [ - "SourceId", - "Property", - "HealthState" - ], - "properties": { - "SourceId": { - "type": "string", - "description": "The source name which identifies the client/watchdog/system component which generated the health information." - }, - "Property": { - "type": "string", - "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "TimeToLiveInMilliSeconds": { - "type": "string", - "format": "duration", - "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value." - }, - "Description": { - "type": "string", - "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string." - }, - "SequenceNumber": { - "type": "string", - "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, is the reporter has issues (eg. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state." - } - } - }, - "HealthState": { - "type": "string", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", - "enum": [ - "Invalid", - "Ok", - "Warning", - "Error", - "Unknown" - ], - "x-ms-enum": { - "name": "HealthState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ok", - "description": "Indicates the health state is okay. The value is 1." - }, - { - "value": "Warning", - "description": "Indicates the health state is at a warning level. The value is 2." - }, - { - "value": "Error", - "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." - }, - { - "value": "Unknown", - "description": "Indicates an unknown health status. The value is 65535." - } - ] - } - }, - "Int64RangePartitionInformation": { - "description": "Describes the partition information for the integer range that is based on partition schemes.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Int64Range", - "properties": { - "LowKey": { - "type": "string", - "description": "Specifies the minimum key value handled by this partition." - }, - "HighKey": { - "type": "string", - "description": "Specifies the maximum key value handled by this partition." - } - } - }, - "MonitoringPolicyDescription": { - "type": "object", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode.", - "properties": { - "FailureAction": { - "$ref": "#/definitions/FailureAction", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." - }, - "HealthCheckWaitDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckWaitDuration", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckStableDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckStableDuration", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "$ref": "#/definitions/HealthCheckRetryTimeout", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeTimeout", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeDomainTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainTimeout", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - } - } - }, - "NamedPartitionInformation": { - "description": "Describes the partition information for the name as a string that is based on partition schemes.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Named", - "properties": { - "Name": { - "type": "string", - "description": "Name of the partition." - } - } - }, - "NextUpgradeDomain": { - "type": "string", - "description": "The name of the next upgrade domain to be processed." - }, - "NodeDeactivationInfo": { - "type": "object", - "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.", - "properties": { - "NodeDeactivationIntent": { - "$ref": "#/definitions/NodeDeactivationIntent", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it." - }, - "NodeDeactivationStatus": { - "$ref": "#/definitions/NodeDeactivationStatus", - "description": "The status of node deactivation operation. Following are the possible values." - }, - "NodeDeactivationTask": { - "$ref": "#/definitions/NodeDeactivationTaskList", - "description": "List of tasks representing the deactivation operation on the node." - }, - "PendingSafetyChecks": { - "$ref": "#/definitions/SafetyCheckInfoList", - "description": "List of pending safety checks" - } - } - }, - "NodeDeactivationIntent": { - "type": "string", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it.", - "enum": [ - "Invalid", - "Pause", - "Restart", - "RemoveData", - "RemoveNode" - ], - "x-ms-enum": { - "name": "NodeDeactivationIntent", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." - }, - { - "value": "Pause", - "description": "Indicates that the node should be paused. The value is 1." - }, - { - "value": "Restart", - "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2." - }, - { - "value": "RemoveData", - "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3." - }, - { - "value": "RemoveNode", - "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4." - } - ] - } - }, - "NodeDeactivationStatus": { - "type": "string", - "description": "The status of node deactivation operation. Following are the possible values.", - "enum": [ - "None", - "SafetyCheckInProgress", - "SafetyCheckComplete", - "Completed" - ], - "x-ms-enum": { - "name": "NodeDeactivationStatus", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No status is associated with the task. The value is zero." - }, - { - "value": "SafetyCheckInProgress", - "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1." - }, - { - "value": "SafetyCheckComplete", - "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2." - }, - { - "value": "Completed", - "description": "The task is completed. The value is 3." - } - ] - } - }, - "NodeDeactivationTask": { - "type": "object", - "description": "The task representing the deactivation operation on the node.", - "properties": { - "NodeDeactivationTaskId": { - "$ref": "#/definitions/NodeDeactivationTaskId", - "description": "Identity of the task related to deactivation operation on the node." - }, - "NodeDeactivationIntent": { - "$ref": "#/definitions/NodeDeactivationIntent", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it." - } - } - }, - "NodeDeactivationTaskId": { - "type": "object", - "description": "Identity of the task related to deactivation operation on the node.", - "properties": { - "Id": { - "type": "string", - "description": "Value of the task id." - }, - "NodeDeactivationTaskType": { - "$ref": "#/definitions/NodeDeactivationTaskType", - "description": "The type of the task that performed the node deactivation. Following are the possible values." - } - } - }, - "NodeDeactivationTaskList": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeDeactivationTask" - }, - "description": "List of tasks representing the deactivation operation on the node." - }, - "NodeDeactivationTaskType": { - "type": "string", - "description": "The type of the task that performed the node deactivation. Following are the possible values.", - "enum": [ - "Invalid", - "Infrastructure", - "Repair", - "Client" - ], - "x-ms-enum": { - "name": "NodeDeactivationTaskType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." - }, - { - "value": "Infrastructure", - "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1." - }, - { - "value": "Repair", - "description": "Specifies the task that was created by the Repair Manager service. The value is 2." - }, - { - "value": "Client", - "description": "Specifies that the task was created by using the public API. The value is 3." - } - ] - } - }, - "NodeEvent": { - "description": "Represents the base for all Node Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "NodeEvent", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - } - }, - "required": [ - "NodeName" - ] - } - ], - "x-ms-discriminator-value": "NodeEvent" - }, - "NodeEventList": { - "description": "A list of NodeEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/NodeEvent" - } - }, - "NodeHealth": { - "description": "Information about the health of a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "NodeHealth", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node whose health information is described by this object." - } - } - } - ] - }, - "NodeHealthEvaluation": { - "x-ms-discriminator-value": "Node", - "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "NodeHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "NodeHealthState": { - "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "NodeHealthState", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "Id": { - "$ref": "#/definitions/NodeId", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." - } - } - } - ] - }, - "NodeHealthStateChunk": { - "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "NodeHealthStateChunk", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - } - } - } - ] - }, - "NodeHealthStateChunkList": { - "type": "object", - "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunkList" - }, - { - "type": "object", - "description": "NodeHealthStateChunkList", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthStateChunk" - }, - "description": "The list of node health state chunks that respect the input filters in the chunk query." - } - } - } - ] - }, - "NodeHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.", - "properties": { - "NodeNameFilter": { - "type": "string", - "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "NodeId": { - "type": "object", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.", - "properties": { - "Id": { - "type": "string", - "description": "Value of the node Id. This is a 128 bit integer." - } - } - }, - "NodeIdList": { - "description": "A list of NodeIds.", - "type": "array", - "items": { - "$ref": "#/definitions/NodeId" - } - }, - "NodeInfo": { - "type": "object", - "description": "Information about a node in Service Fabric cluster.", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "The IP address or fully qualified domain name of the node." - }, - "Type": { - "type": "string", - "description": "The type of the node." - }, - "CodeVersion": { - "type": "string", - "description": "The version of Service Fabric binaries that the node is running." - }, - "ConfigVersion": { - "type": "string", - "description": "The version of Service Fabric cluster manifest that the node is using." - }, - "NodeStatus": { - "$ref": "#/definitions/NodeStatus", - "description": "The status of the node." - }, - "NodeUpTimeInSeconds": { - "type": "string", - "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster." - }, - "UpgradeDomain": { - "type": "string", - "description": "The upgrade domain of the node." - }, - "FaultDomain": { - "type": "string", - "description": "The fault domain of the node." - }, - "Id": { - "$ref": "#/definitions/NodeId", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." - }, - "InstanceId": { - "type": "string", - "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts." - }, - "NodeDeactivationInfo": { - "$ref": "#/definitions/NodeDeactivationInfo", - "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated." - }, - "IsStopped": { - "type": "boolean", - "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false." - }, - "NodeDownTimeInSeconds": { - "type": "string", - "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down." - }, - "NodeUpAt": { - "type": "string", - "format": "date-time", - "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time." - }, - "NodeDownAt": { - "type": "string", - "format": "date-time", - "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time." - } - } - }, - "NodeLoadInfo": { - "type": "object", - "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node for which the load information is provided by this object." - }, - "NodeLoadMetricInformation": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeLoadMetricInformation" - }, - "description": "List that contains metrics and their load information on this node." - } - } - }, - "NodeLoadMetricInformation": { - "type": "object", - "description": "Represents data structure that contains load information for a certain metric on a node.", - "properties": { - "Name": { - "type": "string", - "description": "Name of the metric for which this load information is provided." - }, - "NodeCapacity": { - "type": "string", - "description": "Total capacity on the node for this metric." - }, - "NodeLoad": { - "type": "string", - "description": "Current load on the node for this metric." - }, - "NodeRemainingCapacity": { - "type": "string", - "description": "The remaining capacity on the node for this metric." - }, - "IsCapacityViolation": { - "type": "boolean", - "description": "Indicates if there is a capacity violation for this metric on the node." - }, - "NodeBufferedCapacity": { - "type": "string", - "description": "The value that indicates the reserved capacity for this metric on the node." - }, - "NodeRemainingBufferedCapacity": { - "type": "string", - "description": "The remaining reserved capacity for this metric on the node." - } - } - }, - "NodeName": { - "type": "string", - "description": "The name of a Service Fabric node." - }, - "NodeType": { - "type": "string", - "description": "The type name of a Service Fabric node.\nPlease refer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-nodetypes) for more details." - }, - "NodesHealthEvaluation": { - "x-ms-discriminator-value": "Nodes", - "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "NodesHealthEvaluation", - "properties": { - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes found in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "NodeStatus": { - "type": "string", - "description": "The status of the node.", - "enum": [ - "Invalid", - "Up", - "Down", - "Enabling", - "Disabling", - "Disabled", - "Unknown", - "Removed" - ], - "x-ms-enum": { - "name": "NodeStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Up", - "description": "Indicates the node is up. The value is 1." - }, - { - "value": "Down", - "description": "Indicates the node is down. The value is 2." - }, - { - "value": "Enabling", - "description": "Indicates the node is in process of being enabled. The value is 3." - }, - { - "value": "Disabling", - "description": "Indicates the node is in the process of being disabled. The value is 4." - }, - { - "value": "Disabled", - "description": "Indicates the node is disabled. The value is 5." - }, - { - "value": "Unknown", - "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6." - }, - { - "value": "Removed", - "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7." - } - ] - } - }, - "NodeUpgradePhase": { - "type": "string", - "description": "The state of the upgrading node.", - "enum": [ - "Invalid", - "PreUpgradeSafetyCheck", - "Upgrading", - "PostUpgradeSafetyCheck" - ], - "x-ms-enum": { - "name": "NodeUpgradePhase", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "PreUpgradeSafetyCheck", - "description": "The upgrade has not started yet due to pending safety checks. The value is 1" - }, - { - "value": "Upgrading", - "description": "The upgrade is in progress. The value is 2" - }, - { - "value": "PostUpgradeSafetyCheck", - "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3" - } - ] - } - }, - "NodeUpgradeProgressInfo": { - "type": "object", - "description": "Information about the upgrading node and its status", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "UpgradePhase": { - "$ref": "#/definitions/NodeUpgradePhase", - "description": "The state of the upgrading node." - }, - "PendingSafetyChecks": { - "$ref": "#/definitions/SafetyCheckInfoList", - "description": "List of pending safety checks" - } - } - }, - "NodeUpgradeProgressInfoList": { - "type": "array", - "description": "List of upgrading nodes and their statuses", - "items": { - "$ref": "#/definitions/NodeUpgradeProgressInfo" - } - }, - "PagedApplicationInfoList": { - "type": "object", - "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of application information.", - "items": { - "$ref": "#/definitions/ApplicationInfo" - } - } - } - }, - "PagedDeployedApplicationInfoList": { - "type": "object", - "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of deployed application information.", - "items": { - "$ref": "#/definitions/DeployedApplicationInfo" - } - } - } - }, - "PagedNodeInfoList": { - "type": "object", - "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of node information.", - "items": { - "$ref": "#/definitions/NodeInfo" - } - } - } - }, - "PagedServicePartitionInfoList": { - "type": "object", - "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service partition information.", - "items": { - "$ref": "#/definitions/ServicePartitionInfo" - } - } - } - }, - "PagedReplicaInfoList": { - "type": "object", - "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of replica information.", - "items": { - "$ref": "#/definitions/ReplicaInfo" - } - } - } - }, - "PagedServiceInfoList": { - "type": "object", - "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service information.", - "items": { - "$ref": "#/definitions/ServiceInfo" - } - } - } - }, - "PartitionAnalysisEvent": { - "description": "Represents the base for all Partition Analysis Events.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "description": "PartitionAnalysisEvent", - "properties": { - "Metadata": { - "$ref": "#/definitions/AnalysisEventMetadata", - "description": "Metadata about an Analysis Event." - } - }, - "required": [ - "Metadata" - ] - } - ], - "x-ms-discriminator-value": "PartitionAnalysisEvent" - }, - "PartitionEvent": { - "description": "Represents the base for all Partition Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "PartitionEvent", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - }, - "required": [ - "PartitionId" - ] - } - ], - "x-ms-discriminator-value": "PartitionEvent" - }, - "PartitionEventList": { - "description": "A list of PartitionEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PartitionEvent" - } - }, - "PartitionHealth": { - "description": "Information about the health of a Service Fabric partition.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "PartitionHealth", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "ID of the partition whose health information is described by this object." - }, - "ReplicaHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthState" - }, - "description": "The list of replica health states associated with the partition." - } - } - } - ] - }, - "PartitionHealthEvaluation": { - "x-ms-discriminator-value": "Partition", - "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "PartitionHealthEvaluation", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition whose health evaluation is described by this object." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "PartitionHealthState": { - "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "PartitionHealthState", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition whose health state is described by this object." - } - } - } - ] - }, - "PartitionHealthStateChunk": { - "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "PartitionHealthStateChunk", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "The Id of the partition." - }, - "ReplicaHealthStateChunks": { - "$ref": "#/definitions/ReplicaHealthStateChunkList", - "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "PartitionHealthStateChunkList": { - "type": "object", - "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthStateChunk" - }, - "description": "The list of partition health state chunks that respect the input filters in the chunk query." - } - } - }, - "PartitionHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.", - "properties": { - "PartitionIdFilter": { - "type": "string", - "format": "uuid", - "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "ReplicaFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthStateFilter" - }, - "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id." - } - } - }, - "PartitionId": { - "type": "string", - "format": "uuid", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "PartitionInformation": { - "type": "object", - "discriminator": "ServicePartitionKind", - "description": "Information about the partition identity, partitioning scheme and keys supported by it.", - "required": [ - "ServicePartitionKind" - ], - "properties": { - "ServicePartitionKind": { - "$ref": "#/definitions/ServicePartitionKind", - "description": "The kind of partitioning scheme used to partition the service." - }, - "Id": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - }, - "ProvisionFabricDescription": { - "type": "object", - "description": "Describes the parameters for provisioning a cluster.", - "properties": { - "CodeFilePath": { - "type": "string", - "description": "The cluster code package file path." - }, - "ClusterManifestFilePath": { - "type": "string", - "description": "The cluster manifest file path." - } - } - }, - "ProvisionApplicationTypeKind": { - "type": "string", - "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.", - "enum": [ - "Invalid", - "ImageStorePath", - "ExternalStore" - ], - "x-ms-enum": { - "name": "ProvisionApplicationTypeKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero." - }, - { - "value": "ImageStorePath", - "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1." - }, - { - "value": "ExternalStore", - "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2." - } - ] - } - }, - "ProvisionApplicationTypeDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.", - "properties": { - "Kind": { - "$ref": "#/definitions/ProvisionApplicationTypeKind", - "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision." - }, - "Async": { - "type": "boolean", - "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true." - } - }, - "required": [ - "Kind", - "Async" - ] - }, - "ProvisionApplicationTypeDescription": { - "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.", - "required": [ - "ApplicationTypeBuildPath" - ], - "allOf": [ - { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - }, - { - "type": "object", - "description": "ProvisionApplicationTypeDescription", - "properties": { - "ApplicationTypeBuildPath": { - "description": "The relative path for the application package in the image store specified during the prior upload operation.", - "type": "string" - }, - "ApplicationPackageCleanupPolicy": { - "$ref": "#/definitions/ApplicationPackageCleanupPolicy", - "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision." - } - } - } - ], - "x-ms-discriminator-value": "ImageStorePath" - }, - "ExternalStoreProvisionApplicationTypeDescription": { - "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - }, - { - "type": "object", - "description": "ExternalStoreProvisionApplicationTypeDescription", - "properties": { - "ApplicationPackageDownloadUri": { - "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.", - "type": "string" - }, - "ApplicationTypeName": { - "description": "The application type name represents the name of the application type found in the application manifest.", - "type": "string" - }, - "ApplicationTypeVersion": { - "description": "The application type version represents the version of the application type found in the application manifest.", - "type": "string" - } - } - } - ], - "x-ms-discriminator-value": "ExternalStore", - "required": [ - "ApplicationPackageDownloadUri", - "ApplicationTypeName", - "ApplicationTypeVersion" - ] - }, - "UnprovisionFabricDescription": { - "type": "object", - "description": "Describes the parameters for unprovisioning a cluster.", - "properties": { - "CodeVersion": { - "type": "string", - "description": "The cluster code package version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster manifest version." - } - } - }, - "ResumeClusterUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for resuming a cluster upgrade.", - "properties": { - "UpgradeDomain": { - "type": "string", - "description": "The next upgrade domain for this cluster upgrade." - } - }, - "required": [ - "UpgradeDomain" - ] - }, - "StartClusterUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for starting a cluster upgrade.", - "properties": { - "CodeVersion": { - "type": "string", - "description": "The cluster code version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster configuration version." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "EnableDeltaHealthEvaluation": { - "type": "boolean", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "UpdateClusterUpgradeDescription": { - "description": "Parameters for updating a cluster upgrade.", - "properties": { - "UpgradeKind": { - "$ref": "#/definitions/UpgradeType", - "description": "The type of upgrade out of the following possible values." - }, - "UpdateDescription": { - "$ref": "#/definitions/RollingUpgradeUpdateDescription", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "EnableDeltaHealthEvaluation": { - "$ref": "#/definitions/DeltaHealthEvaluationBool", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "SafetyCheckKind": { - "type": "string", - "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.", - "enum": [ - "Invalid", - "EnsureSeedNodeQuorum", - "EnsurePartitionQuorum", - "WaitForPrimaryPlacement", - "WaitForPrimarySwap", - "WaitForReconfiguration", - "WaitForInbuildReplica", - "EnsureAvailability" - ], - "x-ms-enum": { - "name": "SafetyCheckKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "EnsureSeedNodeQuorum", - "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1." - }, - { - "value": "EnsurePartitionQuorum", - "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2." - }, - { - "value": "WaitForPrimaryPlacement", - "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3." - }, - { - "value": "WaitForPrimarySwap", - "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4." - }, - { - "value": "WaitForReconfiguration", - "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5." - }, - { - "value": "WaitForInbuildReplica", - "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6." - }, - { - "value": "EnsureAvailability", - "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7." - } - ] - } - }, - "SafetyCheck": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", - "properties": { - "Kind": { - "$ref": "#/definitions/SafetyCheckKind", - "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks." - } - }, - "required": [ - "Kind" - ] - }, - "PartitionSafetyCheck": { - "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.", - "allOf": [ - { - "$ref": "#/definitions/SafetyCheck" - }, - { - "type": "object", - "description": "PartitionSafetyCheck", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition which is undergoing the safety check." - } - } - } - ] - }, - "EnsureAvailabilitySafetyCheck": { - "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "EnsureAvailabilitySafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsureAvailability" - }, - "EnsurePartitionQurumSafetyCheck": { - "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "EnsurePartitionQurumSafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsurePartitionQuorum" - }, - "SeedNodeSafetyCheck": { - "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.", - "allOf": [ - { - "$ref": "#/definitions/SafetyCheck" - }, - { - "type": "object", - "description": "SeedNodeSafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsureSeedNodeQuorum" - }, - "PartitionsHealthEvaluation": { - "x-ms-discriminator-value": "Partitions", - "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "PartitionsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of partitions of the service from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ReplicaEvent": { - "description": "Represents the base for all Replica Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ReplicaEvent", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "ReplicaId": { - "$ref": "#/definitions/ReplicaId_Integer", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - }, - "required": [ - "PartitionId", - "ReplicaId" - ] - } - ], - "x-ms-discriminator-value": "ReplicaEvent" - }, - "ReplicaEventList": { - "description": "A list of ReplicaEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaEvent" - } - }, - "ReplicaHealth": { - "discriminator": "ServiceKind", - "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ReplicaHealth", - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition to which this replica belongs." - } - }, - "required": [ - "ServiceKind" - ] - } - ] - }, - "ReplicaHealthEvaluation": { - "x-ms-discriminator-value": "Replica", - "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ReplicaHealthEvaluation", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition to which the replica belongs." - }, - "ReplicaOrInstanceId": { - "$ref": "#/definitions/ReplicaOrInstanceId", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "ReplicaHealthState": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "description": "Represents a base class for stateful service replica or stateless service instance health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ReplicaHealthState", - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "The ID of the partition to which this replica belongs." - } - } - } - ] - }, - "ReplicaHealthStateChunk": { - "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ReplicaHealthStateChunk", - "properties": { - "ReplicaOrInstanceId": { - "$ref": "#/definitions/ReplicaOrInstanceId", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - } - } - } - ] - }, - "ReplicaHealthStateChunkList": { - "type": "object", - "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthStateChunk" - }, - "description": "The list of replica health state chunks that respect the input filters in the chunk query." - } - } - }, - "ReplicaHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.", - "properties": { - "ReplicaOrInstanceIdFilter": { - "type": "string", - "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "ReplicaId": { - "type": "string", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaId_Integer": { - "type": "integer", - "format": "int64", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaOrInstanceId": { - "type": "string", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - }, - "ReplicaInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ReplicaStatus": { - "$ref": "#/definitions/ReplicaStatus", - "description": "The status of a replica of a service." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "Address": { - "type": "string", - "description": "The address the replica is listening on." - }, - "LastInBuildDurationInSeconds": { - "type": "string", - "description": "The last in build duration of the replica in seconds." - } - } - }, - "ReplicaRole": { - "type": "string", - "description": "The role of a replica of a stateful service.", - "enum": [ - "Unknown", - "None", - "Primary", - "IdleSecondary", - "ActiveSecondary" - ], - "x-ms-enum": { - "name": "ReplicaRole", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the initial role that a replica is created in. The value is zero." - }, - { - "value": "None", - "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1" - }, - { - "value": "Primary", - "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2." - }, - { - "value": "IdleSecondary", - "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3." - }, - { - "value": "ActiveSecondary", - "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4." - } - ] - } - }, - "ReplicasHealthEvaluation": { - "x-ms-discriminator-value": "Replicas", - "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ReplicasHealthEvaluation", - "properties": { - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of replicas in the partition from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ReplicaStatus": { - "type": "string", - "description": "The status of a replica of a service.", - "enum": [ - "Invalid", - "InBuild", - "Standby", - "Ready", - "Down", - "Dropped" - ], - "x-ms-enum": { - "name": "ReplicaStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "InBuild", - "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1." - }, - { - "value": "Standby", - "description": "The replica is in standby. The value is 2." - }, - { - "value": "Ready", - "description": "The replica is ready. The value is 3." - }, - { - "value": "Down", - "description": "The replica is down. The value is 4." - }, - { - "value": "Dropped", - "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5." - } - ] - } - }, - "RestartNodeDescription": { - "description": "Describes the parameters to restart a Service Fabric node.", - "properties": { - "NodeInstanceId": { - "type": "string", - "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.", - "default": "0" - }, - "CreateFabricDump": { - "type": "string", - "description": "Specify True to create a dump of the fabric node process. This is case sensitive.", - "enum": [ - "False", - "True" - ], - "default": "False", - "x-ms-enum": { - "name": "CreateFabricDump", - "modelAsString": true, - "values": [ - { - "value": "False" - }, - { - "value": "True" - } - ] - } - } - }, - "required": [ - "NodeInstanceId" - ] - }, - "SafetyCheckInfoList": { - "type": "array", - "description": "List of pending safety checks", - "items": { - "$ref": "#/definitions/SafetyCheckWrapper" - } - }, - "SafetyCheckWrapper": { - "type": "object", - "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", - "properties": { - "SafetyCheck": { - "$ref": "#/definitions/SafetyCheck", - "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state." - } - } - }, - "ServiceEvent": { - "description": "Represents the base for all Service Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ServiceEvent", - "properties": { - "ServiceId": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - } - }, - "required": [ - "ServiceId" - ] - } - ], - "x-ms-discriminator-value": "ServiceEvent" - }, - "ServiceEventList": { - "description": "A list of ServiceEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEvent" - } - }, - "ServiceFromTemplateDescription": { - "type": "object", - "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.", - "required": [ - "ApplicationName", - "ServiceName", - "ServiceTypeName" - ], - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "InitializationData": { - "$ref": "#/definitions/ByteArray", - "description": "The initialization data for the newly created service instance." - }, - "ServicePackageActivationMode": { - "$ref": "#/definitions/ServicePackageActivationMode", - "description": "The activation mode of service package to be used for a service." - }, - "ServiceDnsName": { - "type": "string", - "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." - } - } - }, - "ServiceHealthEvaluation": { - "x-ms-discriminator-value": "Service", - "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ServiceHealthEvaluation", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Name of the service whose health evaluation is described by this object." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "ServiceHealthState": { - "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ServiceHealthState", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Name of the service whose health state is represented by this object." - } - } - } - ] - }, - "ServiceHealthStateChunk": { - "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ServiceHealthStateChunk", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service whose health state chunk is provided in this object." - }, - "PartitionHealthStateChunks": { - "$ref": "#/definitions/PartitionHealthStateChunkList", - "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "ServiceHealthStateChunkList": { - "type": "object", - "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthStateChunk" - }, - "description": "The list of service health state chunks that respect the input filters in the chunk query." - } - } - }, - "ServiceHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.", - "properties": { - "ServiceNameFilter": { - "type": "string", - "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "PartitionFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthStateFilter" - }, - "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID." - } - } - }, - "ServiceHealth": { - "description": "Information about the health of a Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ServiceHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service whose health information is described by this object." - }, - "PartitionHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthState" - }, - "description": "The list of partition health states associated with the service." - } - } - } - ] - }, - "ServiceId": { - "type": "string", - "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceName": { - "type": "string", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "type": "string", - "description": "The name of the service manifest." - }, - "ServiceTypeName": { - "type": "string", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service.", - "properties": { - "Id": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ManifestVersion": { - "description": "The version of the service manifest.", - "type": "string" - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "ServiceStatus": { - "$ref": "#/definitions/ServiceStatus", - "description": "The status of the application." - }, - "IsServiceGroup": { - "description": "Whether the service is in a service group.", - "type": "boolean" - } - }, - "required": [ - "ServiceKind" - ] - }, - "ServiceKind": { - "type": "string", - "description": "The kind of service (Stateless or Stateful).", - "enum": [ - "Invalid", - "Stateless", - "Stateful" - ], - "x-ms-enum": { - "name": "ServiceKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Stateless", - "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." - }, - { - "value": "Stateful", - "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." - } - ] - } - }, - "ServiceNameInfo": { - "type": "object", - "description": "Information about the service name.", - "properties": { - "Id": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - }, - "ServicePackageActivationId": { - "type": "string", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "ServicePartitionInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a partition of a Service Fabric service.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "PartitionStatus": { - "$ref": "#/definitions/ServicePartitionStatus", - "description": "The status of the service fabric service partition." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "Information about the partition identity, partitioning scheme and keys supported by it." - } - } - }, - "ServicePartitionKind": { - "type": "string", - "description": "The kind of partitioning scheme used to partition the service.", - "enum": [ - "Invalid", - "Singleton", - "Int64Range", - "Named" - ], - "x-ms-enum": { - "name": "ServicePartitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Singleton", - "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1." - }, - { - "value": "Int64Range", - "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2." - }, - { - "value": "Named", - "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3." - } - ] - } - }, - "ServicePartitionStatus": { - "type": "string", - "description": "The status of the service fabric service partition.", - "enum": [ - "Invalid", - "Ready", - "NotReady", - "InQuorumLoss", - "Reconfiguring", - "Deleting" - ], - "x-ms-enum": { - "name": "ServicePartitionStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ready", - "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1." - }, - { - "value": "NotReady", - "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2." - }, - { - "value": "InQuorumLoss", - "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3." - }, - { - "value": "Reconfiguring", - "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4." - }, - { - "value": "Deleting", - "description": "Indicates that the partition is being deleted. The value is 5." - } - ] - } - }, - "ServicePlacementInvalidDomainPolicyDescription": { - "x-ms-discriminator-value": "InvalidDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementInvalidDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should not be used for placement." - } - } - } - ] - }, - "ServicePlacementNonPartiallyPlaceServicePolicyDescription": { - "x-ms-discriminator-value": "NonPartiallyPlaceService", - "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementNonPartiallyPlaceServicePolicyDescription" - } - ] - }, - "ServicePlacementPolicyDescription": { - "type": "object", - "discriminator": "Type", - "description": "Describes the policy to be used for placement of a Service Fabric service.", - "required": [ - "Type" - ], - "properties": { - "Type": { - "$ref": "#/definitions/ServicePlacementPolicyType", - "description": "The type of placement policy for a service fabric service. Following are the possible values." - } - } - }, - "ServicePlacementPolicyDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "List of service placement policy descriptions." - }, - "ServicePlacementPolicyType": { - "type": "string", - "description": "The type of placement policy for a service fabric service. Following are the possible values.", - "enum": [ - "Invalid", - "InvalidDomain", - "RequiredDomain", - "PreferredPrimaryDomain", - "RequiredDomainDistribution", - "NonPartiallyPlaceService" - ], - "x-ms-enum": { - "name": "ServicePlacementPolicyType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "InvalidDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." - }, - { - "value": "RequiredDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." - }, - { - "value": "PreferredPrimaryDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." - }, - { - "value": "RequiredDomainDistribution", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." - }, - { - "value": "NonPartiallyPlaceService", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." - } - ] - } - }, - "ServicePlacementPreferPrimaryDomainPolicyDescription": { - "x-ms-discriminator-value": "PreferredPrimaryDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service�s primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementPreferPrimaryDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicePlacementRequiredDomainPolicyDescription": { - "x-ms-discriminator-value": "RequiredDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementRequiredDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicePlacementRequireDomainDistributionPolicyDescription": { - "x-ms-discriminator-value": "RequiredDomainDistribution", - "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementRequireDomainDistributionPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicesHealthEvaluation": { - "x-ms-discriminator-value": "Services", - "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ServicesHealthEvaluation", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Name of the service type of the services." - }, - "MaxPercentUnhealthyServices": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of services of the current service type in the application from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ServiceStatus": { - "type": "string", - "description": "The status of the application.", - "enum": [ - "Unknown", - "Active", - "Upgrading", - "Deleting", - "Creating", - "Failed" - ], - "x-ms-enum": { - "name": "ServiceStatus", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the service status is unknown. The value is zero." - }, - { - "value": "Active", - "description": "Indicates the service status is active. The value is 1." - }, - { - "value": "Upgrading", - "description": "Indicates the service is upgrading. The value is 2." - }, - { - "value": "Deleting", - "description": "Indicates the service is being deleted. The value is 3." - }, - { - "value": "Creating", - "description": "Indicates the service is being created. The value is 4." - }, - { - "value": "Failed", - "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5." - } - ] - } - }, - "ServiceTypeDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster." - }, - "LoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPolicyDescriptionList", - "description": "List of service placement policy descriptions." - }, - "Extensions": { - "$ref": "#/definitions/ServiceTypeExtensionDescriptionList", - "description": "List of service type extensions." - } - } - }, - "ServiceTypeExtensionDescription": { - "type": "object", - "description": "Describes extension of a service type defined in the service manifest.", - "properties": { - "Key": { - "type": "string", - "description": "The name of the extension." - }, - "Value": { - "type": "string", - "description": "The extension value." - } - } - }, - "ServiceTypeExtensionDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeExtensionDescription" - }, - "description": "List of service type extensions." - }, - "ServiceTypeHealthPolicy": { - "type": "object", - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.", - "default": 0 - }, - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.", - "default": 0 - }, - "MaxPercentUnhealthyServices": { - "type": "integer", - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", - "default": 0 - } - } - }, - "ServiceTypeHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" - }, - "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation." - }, - "ServiceTypeHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ServiceTypeHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key of the service type health policy map item. This is the name of the service type." - }, - "Value": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type." - } - } - }, - "ServiceTypeInfo": { - "type": "object", - "description": "Information about a service type that is defined in a service manifest of a provisioned application type.", - "properties": { - "ServiceTypeDescription": { - "$ref": "#/definitions/ServiceTypeDescription", - "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "ServiceManifestVersion": { - "type": "string", - "description": "The version of the service manifest in which this service type is defined." - }, - "IsServiceGroup": { - "type": "boolean", - "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false." - } - } - }, - "ServiceTypeInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeInfo" - }, - "description": "List of service type information." - }, - "ServiceTypeManifest": { - "type": "object", - "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.", - "properties": { - "Manifest": { - "type": "string", - "description": "The XML manifest as a string." - } - } - }, - "SingletonPartitionInformation": { - "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "StatefulServiceInfo": { - "description": "Information about a stateful Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceInfo" - }, - { - "type": "object", - "description": "StatefulService", - "properties": { - "HasPersistedState": { - "description": "Whether the service has persisted state.", - "type": "boolean" - } - } - } - ], - "x-ms-discriminator-value": "Stateful" - }, - "StatefulServicePartitionInfo": { - "description": "Information about a partition of a stateful Service Fabric service..", - "allOf": [ - { - "$ref": "#/definitions/ServicePartitionInfo" - }, - { - "type": "object", - "description": "StatefulServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "format": "int64", - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int64", - "description": "The minimum replica set size as a number." - }, - "LastQuorumLossDuration": { - "type": "string", - "format": "duration", - "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration." - }, - "CurrentConfigurationEpoch": { - "$ref": "#/definitions/Epoch", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica." - } - } - }, - "StatefulServiceReplicaHealth": { - "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealth" - }, - { - "type": "object", - "description": "StatefulServiceReplicaHealth", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatefulServiceReplicaHealthState": { - "x-ms-discriminator-value": "Stateful", - "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealthState" - }, - { - "type": "object", - "description": "StatefulServiceReplicaHealthState", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatefulServiceTypeDescription": { - "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.", - "allOf": [ - { - "$ref": "#/definitions/ServiceTypeDescription" - }, - { - "type": "object", - "description": "StatefulServiceTypeDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "HasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - } - } - }, - "StatelessServiceInfo": { - "description": "Information about a stateless Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceInfo" - }, - { - "type": "object", - "description": "StatelessService" - } - ], - "x-ms-discriminator-value": "Stateless" - }, - "StatelessServiceInstanceHealth": { - "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealth" - }, - { - "type": "object", - "description": "StatelessServiceInstanceHealth", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "StatelessServiceInstanceHealthState": { - "x-ms-discriminator-value": "Stateless", - "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealthState" - }, - { - "type": "object", - "description": "StatelessServiceInstanceHealthState", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of the stateless service instance on the wire this field is called ReplicaId." - } - } - } - ] - }, - "StatelessServicePartitionInfo": { - "description": "Information about a partition of a stateless Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServicePartitionInfo" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "InstanceCount": { - "type": "integer", - "format": "int64", - "description": "Number of instances of this partition." - } - } - }, - "StatelessServiceTypeDescription": { - "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", - "allOf": [ - { - "$ref": "#/definitions/ServiceTypeDescription" - }, - { - "type": "object", - "description": "StatelessServiceTypeDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "UseImplicitHost": { - "type": "boolean", - "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise." - } - } - }, - "SystemApplicationHealthEvaluation": { - "x-ms-discriminator-value": "SystemApplication", - "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "SystemApplicationHealthEvaluation", - "properties": { - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "TargetApplicationName": { - "type": "string", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TargetApplicationTypeVersion": { - "type": "string", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "TargetDeploymentName": { - "type": "string", - "description": "The name of the target deployment." - }, - "UnhealthyEvaluations": { - "description": "List of health evaluations that resulted in the current aggregated health state.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvaluationWrapper" - } - }, - "UpgradeDomainDeltaNodesCheckHealthEvaluation": { - "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck", - "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "UpgradeDomainDeltaNodesCheckHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "Name of the upgrade domain where nodes health is currently evaluated." - }, - "BaselineErrorCount": { - "type": "integer", - "format": "int64", - "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." - }, - "BaselineTotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade." - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of upgrade domain nodes in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "UpgradeDomainInfo": { - "type": "object", - "description": "Information about an upgrade domain.", - "properties": { - "Name": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "State": { - "$ref": "#/definitions/UpgradeDomainState", - "description": "The state of the upgrade domain." - } - } - }, - "UpgradeDomainInfoList": { - "type": "array", - "description": "List of upgrade domains and their statuses.", - "items": { - "$ref": "#/definitions/UpgradeDomainInfo" - } - }, - "UpgradeDomainName": { - "type": "string", - "description": "The name of the upgrade domain" - }, - "UpgradeDomainNodesHealthEvaluation": { - "x-ms-discriminator-value": "UpgradeDomainNodes", - "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "UpgradeDomainNodesHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "Name of the upgrade domain where nodes health is currently evaluated." - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "UpgradeDomainState": { - "type": "string", - "description": "The state of the upgrade domain.", - "enum": [ - "Invalid", - "Pending", - "InProgress", - "Completed" - ], - "x-ms-enum": { - "name": "UpgradeDomainState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Pending", - "description": "The upgrade domain has not started upgrading yet. The value is 1" - }, - { - "value": "InProgress", - "description": "The upgrade domain is being upgraded but not complete yet. The value is 2" - }, - { - "value": "Completed", - "description": "The upgrade domain has completed upgrade. The value is 3" - } - ] - } - }, - "UpgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeDuration": { - "type": "string", - "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "UpgradeKind": { - "type": "string", - "description": "The kind of upgrade out of the following possible values.", - "default": "Rolling", - "enum": [ - "Invalid", - "Rolling" - ], - "x-ms-enum": { - "name": "UpgradeKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rolling", - "description": "The upgrade progresses one upgrade domain at a time. The value is 1" - } - ] - } - }, - "UpgradeMode": { - "type": "string", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.", - "enum": [ - "Invalid", - "UnmonitoredAuto", - "UnmonitoredManual", - "Monitored" - ], - "default": "UnmonitoredAuto", - "x-ms-enum": { - "name": "UpgradeMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "UnmonitoredAuto", - "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1" - }, - { - "value": "UnmonitoredManual", - "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2" - }, - { - "value": "Monitored", - "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3" - } - ] - } - }, - "UpgradeType": { - "type": "string", - "description": "The type of upgrade out of the following possible values.", - "default": "Rolling", - "enum": [ - "Invalid", - "Rolling", - "Rolling_ForceRestart" - ], - "x-ms-enum": { - "name": "UpgradeType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rolling", - "description": "The upgrade progresses one upgrade domain at a time. The value is 1." - }, - { - "value": "Rolling_ForceRestart", - "description": "The upgrade gets restarted by force. The value is 2." - } - ] - } - }, - "UpgradeReplicaSetCheckTimeout": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", - "default": 42949672925 - }, - "UpgradeState": { - "type": "string", - "description": "The state of the upgrade domain.", - "enum": [ - "Invalid", - "RollingBackInProgress", - "RollingBackCompleted", - "RollingForwardPending", - "RollingForwardInProgress", - "RollingForwardCompleted", - "Failed" - ], - "x-ms-enum": { - "name": "UpgradeState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "RollingBackInProgress", - "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1" - }, - { - "value": "RollingBackCompleted", - "description": "The upgrade has finished rolling back. The value is 2" - }, - { - "value": "RollingForwardPending", - "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" - }, - { - "value": "RollingForwardInProgress", - "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4" - }, - { - "value": "RollingForwardCompleted", - "description": "The upgrade has finished rolling forward. The value is 5" - }, - { - "value": "Failed", - "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6" - } - ] - } - }, - "UpgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "WaitForInbuildReplicaSafetyCheck": { - "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForInbuildReplicaSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForInbuildReplica" - }, - "WaitForPrimaryPlacementSafetyCheck": { - "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForPrimaryPlacementSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForPrimaryPlacement" - }, - "WaitForPrimarySwapSafetyCheck": { - "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForPrimarySwapSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForPrimarySwap" - }, - "WaitForReconfigurationSafetyCheck": { - "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForReconfigurationSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForReconfiguration" - }, - "LoadMetricReport": { - "type": "object", - "description": "Represents the load metric report which contains the time metric was reported, its name and value.", - "properties": { - "LastReportedUtc": { - "type": "string", - "format": "date-time", - "description": "Gets the UTC time when the load was reported." - }, - "Name": { - "type": "string", - "description": "The name of the load metric." - }, - "Value": { - "type": "string", - "format": "int32", - "description": "The value of the load metric." - } - } - }, - "PartitionLoadInformation": { - "type": "object", - "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition." - }, - "PrimaryLoadMetricReports": { - "type": "array", - "description": "Array of load reports from the primary replica for this partition.", - "items": { - "$ref": "#/definitions/LoadMetricReport" - } - }, - "SecondaryLoadMetricReports": { - "type": "array", - "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.", - "items": { - "$ref": "#/definitions/LoadMetricReport" - } - } - } - }, - "StatefulServiceReplicaInfo": { - "x-ms-discriminator-value": "Stateful", - "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaInfo" - }, - { - "type": "object", - "description": "StatefulServiceReplicaInfo", - "properties": { - "ReplicaRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - }, - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatelessServiceInstanceInfo": { - "x-ms-discriminator-value": "Stateless", - "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaInfo" - }, - { - "type": "object", - "description": "StatelessServiceInstanceInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "ClusterFabricCodeVersionString": { - "type": "string", - "description": "The ServiceFabric code version of the cluster." - }, - "ClusterFabricConfigVersionString": { - "type": "string", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "ClusterUpgradeDescriptionObject": { - "type": "object", - "description": "Represents a ServiceFabric cluster upgrade", - "properties": { - "ConfigVersion": { - "$ref": "#/definitions/ClusterFabricConfigVersionString", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "CodeVersion": { - "$ref": "#/definitions/ClusterFabricCodeVersionString", - "description": "The ServiceFabric code version of the cluster." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "EnableDeltaHealthEvaluation": { - "$ref": "#/definitions/DeltaHealthEvaluationBool", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - } - } - }, - "ClusterUpgradeHealthPolicyObject": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.", - "properties": { - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.", - "maximum": 100, - "minimum": 0 - }, - "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.", - "maximum": 100, - "minimum": 0 - } - } - }, - "ClusterUpgradeProgressObject": { - "type": "object", - "description": "Information about a cluster upgrade.", - "properties": { - "CodeVersion": { - "$ref": "#/definitions/ClusterFabricCodeVersionString", - "description": "The ServiceFabric code version of the cluster." - }, - "ConfigVersion": { - "$ref": "#/definitions/ClusterFabricConfigVersionString", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "UpgradeDomains": { - "$ref": "#/definitions/UpgradeDomainInfoList", - "description": "List of upgrade domains and their statuses." - }, - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "NextUpgradeDomain": { - "$ref": "#/definitions/NextUpgradeDomain", - "description": "The name of the next upgrade domain to be processed." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeDescription": { - "$ref": "#/definitions/ClusterUpgradeDescriptionObject", - "description": "Represents a ServiceFabric cluster upgrade" - }, - "UpgradeDurationInMilliseconds": { - "$ref": "#/definitions/UpgradeDurationString", - "description": "The estimated elapsed time spent processing the current overall upgrade." - }, - "UpgradeDomainDurationInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainDurationString", - "description": "The estimated elapsed time spent processing the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "$ref": "#/definitions/UpgradeStartTimeUTCString", - "description": "The start time of the upgrade in UTC." - }, - "FailureTimestampUtc": { - "$ref": "#/definitions/UpgradeFailureTimeUTCString", - "description": "The failure time of the upgrade in UTC." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailedUpgradeDomainProgressObject", - "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure." - } - } - }, - "ClusterConfigurationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for a standalone cluster configuration upgrade.", - "properties": { - "ClusterConfig": { - "type": "string", - "description": "The cluster configuration." - }, - "HealthCheckRetryTimeout": { - "type": "string", - "format": "duration", - "description": "The length of time between attempts to perform a health checks if the application or cluster is not healthy.", - "default": "PT0H0M0S" - }, - "HealthCheckWaitDurationInSeconds": { - "type": "string", - "format": "duration", - "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.", - "default": "PT0H0M0S" - }, - "HealthCheckStableDurationInSeconds": { - "type": "string", - "format": "duration", - "description": "The length of time that the application or cluster must remain healthy.", - "default": "PT0H0M0S" - }, - "UpgradeDomainTimeoutInSeconds": { - "type": "string", - "format": "duration", - "description": "The timeout for the upgrade domain.", - "default": "PT0H0M0S" - }, - "UpgradeTimeoutInSeconds": { - "type": "string", - "format": "duration", - "description": "The upgrade timeout.", - "default": "PT0H0M0S" - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - } - }, - "required": [ - "ClusterConfig" - ] - }, - "DeltaHealthEvaluationBool": { - "type": "boolean", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "FailedUpgradeDomainProgressObject": { - "type": "object", - "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "UpgradeDomainDurationString": { - "type": "string", - "description": "The estimated elapsed time spent processing the current upgrade domain." - }, - "UpgradeDurationString": { - "type": "string", - "description": "The estimated elapsed time spent processing the current overall upgrade." - }, - "UpgradeFailureTimeUTCString": { - "type": "string", - "description": "The failure time of the upgrade in UTC." - }, - "UpgradeStartTimeUTCString": { - "type": "string", - "description": "The start time of the upgrade in UTC." - }, - "UpgradeOrchestrationServiceState": { - "type": "object", - "description": "Service state of Service Fabric Upgrade Orchestration Service.", - "properties": { - "ServiceState": { - "type": "string", - "description": "The state of Service Fabric Upgrade Orchestration Service." - } - } - }, - "UpgradeOrchestrationServiceStateSummary": { - "type": "object", - "description": "Service state summary of Service Fabric Upgrade Orchestration Service.", - "properties": { - "CurrentCodeVersion": { - "type": "string", - "description": "The current code version of the cluster." - }, - "CurrentManifestVersion": { - "type": "string", - "description": "The current manifest version of the cluster." - }, - "TargetCodeVersion": { - "type": "string", - "description": "The target code version of the cluster." - }, - "TargetManifestVersion": { - "type": "string", - "description": "The target manifest version of the cluster." - }, - "PendingUpgradeType": { - "type": "string", - "description": "The type of the pending upgrade of the cluster." - } - } - }, - "ApplicationTypeImageStorePath": { - "description": "Path description for the application package in the image store specified during the prior copy operation.", - "required": [ - "ApplicationTypeBuildPath" - ], - "properties": { - "ApplicationTypeBuildPath": { - "type": "string", - "description": "The relative image store path to the application package." - } - } - }, - "UnprovisionApplicationTypeDescriptionInfo": { - "type": "object", - "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.", - "required": [ - "ApplicationTypeVersion" - ], - "properties": { - "ApplicationTypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "Async": { - "type": "boolean", - "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend to set it to true for large application packages that were provisioned." - } - } - }, - "CodePackageName": { - "type": "string", - "description": "The name of the code package defined in the service manifest." - }, - "CodePackageEntryPointStatistics": { - "type": "object", - "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.", - "properties": { - "LastExitCode": { - "type": "string", - "description": "The last exit code of the entry point." - }, - "LastActivationTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when Service Fabric attempted to run the entry point." - }, - "LastExitTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point finished running." - }, - "LastSuccessfulActivationTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point ran successfully." - }, - "LastSuccessfulExitTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point finished running gracefully." - }, - "ActivationCount": { - "type": "string", - "description": "Number of times the entry point has run." - }, - "ActivationFailureCount": { - "type": "string", - "description": "Number of times the entry point failed to run." - }, - "ContinuousActivationFailureCount": { - "type": "string", - "description": "Number of times the entry point continuously failed to run." - }, - "ExitCount": { - "type": "string", - "description": "Number of times the entry point finished running." - }, - "ExitFailureCount": { - "type": "string", - "description": "Number of times the entry point failed to exit gracefully." - }, - "ContinuousExitFailureCount": { - "type": "string", - "description": "Number of times the entry point continuously failed to exit gracefully." - } - } - }, - "DeployedCodePackageInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedCodePackageInfo" - }, - "description": "List of deployed code package information." - }, - "DeployedCodePackageInfo": { - "type": "object", - "description": "Information about code package deployed on a Service Fabric node.", - "properties": { - "Name": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package." - }, - "Version": { - "type": "string", - "description": "The version of the code package specified in service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest that specified this code package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "HostType": { - "$ref": "#/definitions/HostType", - "description": "Specifies the type of host for main entry point of a code package as specified in service manifest." - }, - "HostIsolationMode": { - "$ref": "#/definitions/HostIsolationMode", - "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest." - }, - "Status": { - "$ref": "#/definitions/DeploymentStatus", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node." - }, - "RunFrequencyInterval": { - "type": "string", - "description": "The interval at which code package is run. This is used for periodic code package." - }, - "SetupEntryPoint": { - "$ref": "#/definitions/CodePackageEntryPoint", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." - }, - "MainEntryPoint": { - "$ref": "#/definitions/CodePackageEntryPoint", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." - } - } - }, - "DeploymentStatus": { - "type": "string", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node.", - "enum": [ - "Invalid", - "Downloading", - "Activating", - "Active", - "Upgrading", - "Deactivating" - ], - "x-ms-enum": { - "name": "DeploymentStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates status of the application or service package is not known or invalid. The value is 0." - }, - { - "value": "Downloading", - "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1." - }, - { - "value": "Activating", - "description": "Indicates the application or service package is being activated. The value is 2." - }, - { - "value": "Active", - "description": "Indicates the application or service package is active the node. The value is 3." - }, - { - "value": "Upgrading", - "description": "Indicates the application or service package is being upgraded. The value is 4." - }, - { - "value": "Deactivating", - "description": "Indicates the application or service package is being deactivated. The value is 5." - } - ] - } - }, - "EntryPointStatus": { - "type": "string", - "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.", - "enum": [ - "Invalid", - "Pending", - "Starting", - "Started", - "Stopping", - "Stopped" - ], - "x-ms-enum": { - "name": "EntryPointStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates status of entry point is not known or invalid. The value is 0." - }, - { - "value": "Pending", - "description": "Indicates the entry point is scheduled to be started. The value is 1." - }, - { - "value": "Starting", - "description": "Indicates the entry point is being started. The value is 2." - }, - { - "value": "Started", - "description": "Indicates the entry point was started successfully and is running. The value is 3." - }, - { - "value": "Stopping", - "description": "Indicates the entry point is being stopped. The value is 4." - }, - { - "value": "Stopped", - "description": "Indicates the entry point is not running. The value is 5." - } - ] - } - }, - "CodePackageEntryPoint": { - "type": "object", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.", - "properties": { - "EntryPointLocation": { - "type": "string", - "description": "The location of entry point executable on the node." - }, - "ProcessId": { - "type": "string", - "description": "The process ID of the entry point." - }, - "RunAsUserName": { - "type": "string", - "description": "The user name under which entry point executable is run on the node." - }, - "CodePackageEntryPointStatistics": { - "$ref": "#/definitions/CodePackageEntryPointStatistics", - "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node." - }, - "Status": { - "$ref": "#/definitions/EntryPointStatus", - "description": "Specifies the status of the code package entry point deployed on a Service Fabric node." - }, - "NextActivationTime": { - "type": "string", - "format": "date-time", - "description": "The time (in UTC) when the entry point executable will be run next." - }, - "InstanceId": { - "$ref": "#/definitions/CodePackageInstanceId", - "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." - } - } - }, - "Chaos": { - "type": "object", - "description": "Contains a description of Chaos.", - "properties": { - "ChaosParameters": { - "$ref": "#/definitions/ChaosParameters", - "description": "If Chaos is running, these are the parameters Chaos is running with." - }, - "Status": { - "$ref": "#/definitions/ChaosStatus", - "description": "Current status of the Chaos run." - }, - "ScheduleStatus": { - "$ref": "#/definitions/ChaosScheduleStatus", - "description": "Current status of the schedule." - } - } - }, - "ChaosStatus": { - "type": "string", - "description": "Current status of the Chaos run.", - "enum": [ - "Invalid", - "Running", - "Stopped" - ], - "x-ms-enum": { - "name": "ChaosStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." - }, - { - "value": "Running", - "description": "Indicates that Chaos is not stopped. The value is one." - }, - { - "value": "Stopped", - "description": "Indicates that Chaos is not scheduling further faults. The value is two." - } - ] - } - }, - "ChaosScheduleStatus": { - "type": "string", - "description": "Current status of the schedule.", - "enum": [ - "Invalid", - "Stopped", - "Active", - "Expired", - "Pending" - ], - "x-ms-enum": { - "name": "ChaosScheduleStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." - }, - { - "value": "Stopped", - "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one." - }, - { - "value": "Active", - "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two." - }, - { - "value": "Expired", - "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three." - }, - { - "value": "Pending", - "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four." - } - ] - } - }, - "ChaosContextMap": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Describes a map that contains a collection of ChaosContextMapItem's." - }, - "ChaosContext": { - "type": "object", - "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.", - "properties": { - "Map": { - "$ref": "#/definitions/ChaosContextMap", - "description": "Describes a map that contains a collection of ChaosContextMapItem's." - } - } - }, - "ChaosParameters": { - "type": "object", - "description": "Defines all the parameters to configure a Chaos run.", - "properties": { - "TimeToRunInSeconds": { - "type": "string", - "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).", - "default": "4294967295" - }, - "MaxClusterStabilizationTimeoutInSeconds": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.", - "default": 60, - "minimum": 0, - "maximum": 4294967295 - }, - "MaxConcurrentFaults": { - "type": "integer", - "format": "int64", - "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults -- inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.", - "default": 1, - "minimum": 0, - "maximum": 4294967295 - }, - "EnableMoveReplicaFaults": { - "type": "boolean", - "description": "Enables or disables the move primary and move secondary faults.", - "default": true - }, - "WaitTimeBetweenFaultsInSeconds": { - "type": "integer", - "format": "int64", - "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.", - "default": 20, - "minimum": 0, - "maximum": 4294967295 - }, - "WaitTimeBetweenIterationsInSeconds": { - "type": "integer", - "format": "int64", - "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.", - "default": 30, - "minimum": 0, - "maximum": 4294967295 - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check." - }, - "Context": { - "$ref": "#/definitions/ChaosContext", - "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run." - }, - "ChaosTargetFilter": { - "$ref": "#/definitions/ChaosTargetFilter", - "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification." - } - } - }, - "ChaosParametersDictionaryItem": { - "type": "object", - "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs." - }, - "Value": { - "$ref": "#/definitions/ChaosParameters", - "description": "Defines all the parameters to configure a Chaos run." - } - } - }, - "ChaosEvent": { - "type": "object", - "discriminator": "Kind", - "description": "Represents an event generated during a Chaos run.", - "properties": { - "Kind": { - "$ref": "#/definitions/ChaosEventKind", - "description": "The kind of Chaos event." - }, - "TimeStampUtc": { - "type": "string", - "description": "The UTC timestamp when this Chaos event was generated.", - "format": "date-time" - } - }, - "required": [ - "Kind", - "TimeStampUtc" - ] - }, - "ChaosEventWrapper": { - "type": "object", - "description": "Wrapper object for Chaos event.", - "properties": { - "ChaosEvent": { - "$ref": "#/definitions/ChaosEvent", - "description": "Represents an event generated during a Chaos run." - } - } - }, - "ChaosEventKind": { - "type": "string", - "description": "The kind of Chaos event.", - "enum": [ - "Invalid", - "Started", - "ExecutingFaults", - "Waiting", - "ValidationFailed", - "TestError", - "Stopped" - ], - "x-ms-enum": { - "name": "ChaosEventKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Started", - "description": "Indicates a Chaos event that gets generated when Chaos is started." - }, - { - "value": "ExecutingFaults", - "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings." - }, - { - "value": "Waiting", - "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish." - }, - { - "value": "ValidationFailed", - "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds." - }, - { - "value": "TestError", - "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted." - }, - { - "value": "Stopped", - "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up." - } - ] - } - }, - "ChaosEventsSegment": { - "type": "object", - "description": "Contains the list of Chaos events and the continuation token to get the next segment.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "History": { - "$ref": "#/definitions/ChaosEventHistory", - "description": "List of Chaos events that meet the user-supplied criteria." - } - } - }, - "ChaosScheduleDescription": { - "type": "object", - "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.", - "properties": { - "Version": { - "description": "The version number of the Schedule.", - "type": "integer", - "format": "int32", - "minimum": 0 - }, - "Schedule": { - "$ref": "#/definitions/ChaosSchedule", - "description": "Defines the schedule used by Chaos." - } - } - }, - "ChaosSchedule": { - "type": "object", - "description": "Defines the schedule used by Chaos.", - "properties": { - "StartDate": { - "type": "string", - "format": "date-time", - "description": "The date and time Chaos will start using this schedule.", - "default": "1601-01-01T00:00:00Z" - }, - "ExpiryDate": { - "type": "string", - "format": "date-time", - "description": "The date and time Chaos will continue to use this schedule until.", - "default": "9999-12-31T23:59:59.999Z" - }, - "ChaosParametersDictionary": { - "type": "array", - "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.", - "items": { - "$ref": "#/definitions/ChaosParametersDictionaryItem" - } - }, - "Jobs": { - "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.", - "type": "array", - "items": { - "$ref": "#/definitions/ChaosScheduleJob" - } - } - } - }, - "ChaosScheduleJob": { - "type": "object", - "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.", - "properties": { - "ChaosParameters": { - "type": "string", - "description": "A reference to which Chaos Parameters of the Chaos Schedule to use." - }, - "Days": { - "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek", - "description": "Defines the days of the week that a Chaos Schedule Job will run for." - }, - "Times": { - "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeRange" - } - } - } - }, - "ChaosScheduleJobActiveDaysOfWeek": { - "type": "object", - "description": "Defines the days of the week that a Chaos Schedule Job will run for.", - "properties": { - "Sunday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Sunday", - "default": false - }, - "Monday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Monday", - "default": false - }, - "Tuesday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Tuesday", - "default": false - }, - "Wednesday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Wednesday", - "default": false - }, - "Thursday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Thursday", - "default": false - }, - "Friday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Friday", - "default": false - }, - "Saturday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Saturday", - "default": false - } - } - }, - "TimeRange": { - "type": "object", - "description": "Defines a time range in a 24 hour day specified by a start and end time.", - "properties": { - "StartTime": { - "$ref": "#/definitions/TimeOfDay", - "description": "Defines an hour and minute of the day specified in 24 hour time." - }, - "EndTime": { - "$ref": "#/definitions/TimeOfDay", - "description": "Defines an hour and minute of the day specified in 24 hour time." - } - } - }, - "TimeOfDay": { - "type": "object", - "description": "Defines an hour and minute of the day specified in 24 hour time.", - "properties": { - "Hour": { - "type": "integer", - "format": "int32", - "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.", - "minimum": 0, - "maximum": 23 - }, - "Minute": { - "type": "integer", - "format": "int32", - "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.", - "minimum": 0, - "maximum": 59 - } - } - }, - "ExecutingFaultsChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.", - "x-ms-discriminator-value": "ExecutingFaults", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "ExecutingFaultsChaosEvent", - "properties": { - "Faults": { - "type": "array", - "description": "List of string description of the faults that Chaos decided to execute in an iteration.", - "items": { - "type": "string" - } - } - } - } - ] - }, - "StartedChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos is started.", - "x-ms-discriminator-value": "Started", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "StartedChaosEvent", - "properties": { - "ChaosParameters": { - "$ref": "#/definitions/ChaosParameters", - "description": "Defines all the parameters to configure a Chaos run." - } - } - } - ] - }, - "StoppedChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.", - "x-ms-discriminator-value": "Stopped", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "StoppedChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over." - } - } - } - ] - }, - "TestErrorChaosEvent": { - "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.", - "x-ms-discriminator-value": "TestError", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "TestErrorChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant." - } - } - } - ] - }, - "ValidationFailedChaosEvent": { - "description": "Chaos event corresponding to a failure during validation.", - "x-ms-discriminator-value": "ValidationFailed", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "ValidationFailedChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string." - } - } - } - ] - }, - "WaitingChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.", - "x-ms-discriminator-value": "Waiting", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "WaitingChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade." - } - } - } - ] - }, - "ChaosEventHistory": { - "type": "array", - "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.", - "items": { - "$ref": "#/definitions/ChaosEventWrapper" - } - }, - "ChaosTargetFilter": { - "type": "object", - "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.", - "properties": { - "NodeTypeInclusionList": { - "type": "array", - "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", - "items": { - "$ref": "#/definitions/NodeType" - } - }, - "ApplicationInclusionList": { - "type": "array", - "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", - "items": { - "$ref": "#/definitions/ApplicationName" - } - } - } - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "The version of the application type as defined in the application manifest." - }, - "ApplicationCapacityDescription": { - "type": "object", - "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application", - "properties": { - "MinimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", - "minimum": 0 - }, - "MaximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", - "minimum": 0, - "default": 0 - }, - "ApplicationMetrics": { - "$ref": "#/definitions/ApplicationMetricDescriptionList", - "description": "List of application capacity metric description." - } - } - }, - "ApplicationDescription": { - "type": "object", - "description": "Describes a Service Fabric application.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "ParameterList": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "ApplicationCapacity": { - "$ref": "#/definitions/ApplicationCapacityDescription", - "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application" - } - }, - "required": [ - "Name", - "TypeName", - "TypeVersion" - ] - }, - "ApplicationMetricDescription": { - "type": "object", - "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "MaximumCapacity": { - "type": "integer", - "format": "int64", - "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity." - }, - "ReservationCapacity": { - "type": "integer", - "format": "int64", - "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric." - }, - "TotalApplicationCapacity": { - "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.", - "type": "integer", - "format": "int64" - } - } - }, - "ApplicationMetricDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationMetricDescription" - }, - "description": "List of application capacity metric description." - }, - "ComposeDeploymentStatus": { - "type": "string", - "description": "The status of the compose deployment.", - "enum": [ - "Invalid", - "Provisioning", - "Creating", - "Ready", - "Unprovisioning", - "Deleting", - "Failed", - "Upgrading" - ], - "x-ms-enum": { - "name": "ComposeDeploymentStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the compose deployment status is invalid. The value is zero." - }, - { - "value": "Provisioning", - "description": "Indicates that the compose deployment is being provisioned in background. The value is 1." - }, - { - "value": "Creating", - "description": "Indicates that the compose deployment is being created in background. The value is 2." - }, - { - "value": "Ready", - "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3." - }, - { - "value": "Unprovisioning", - "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4." - }, - { - "value": "Deleting", - "description": "Indicates that the compose deployment is being deleted in background. The value is 5." - }, - { - "value": "Failed", - "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6." - }, - { - "value": "Upgrading", - "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7." - } - ] - } - }, - "ComposeDeploymentStatusInfo": { - "type": "object", - "description": "Information about a Service Fabric compose deployment.", - "properties": { - "Name": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "Status": { - "$ref": "#/definitions/ComposeDeploymentStatus", - "description": "The status of the compose deployment." - }, - "StatusDetails": { - "description": "The status details of compose deployment including failure message.", - "type": "string" - } - } - }, - "ComposeDeploymentUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for a compose deployment upgrade.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ComposeFileContent": { - "type": "string", - "description": "The content of the compose file that describes the deployment to create." - }, - "RegistryCredential": { - "$ref": "#/definitions/RegistryCredential", - "description": "Credential information to connect to container registry." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - } - }, - "required": [ - "DeploymentName", - "ComposeFileContent", - "UpgradeKind" - ] - }, - "ComposeDeploymentUpgradeProgressInfo": { - "type": "object", - "description": "Describes the parameters for a compose deployment upgrade.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/TargetDeploymentName", - "description": "The name of the target deployment." - }, - "ApplicationName": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "UpgradeState": { - "$ref": "#/definitions/ComposeDeploymentUpgradeState", - "description": "The state of the compose deployment upgrade." - }, - "UpgradeStatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the pending upgrade." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "UpgradeDuration": { - "$ref": "#/definitions/UpgradeDuration", - "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "CurrentUpgradeDomainDuration": { - "$ref": "#/definitions/CurrentUpgradeDomainDuration", - "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "ApplicationUnhealthyEvaluations": { - "$ref": "#/definitions/ApplicationUnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade started." - }, - "FailureTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", - "description": "Information about the upgrade domain progress at the time of upgrade failure." - }, - "ApplicationUpgradeStatusDetails": { - "type": "string", - "description": "Additional details of application upgrade including failure message." - } - } - }, - "ComposeDeploymentUpgradeState": { - "type": "string", - "description": "The state of the compose deployment upgrade.", - "enum": [ - "Invalid", - "ProvisioningTarget", - "RollingForwardInProgress", - "RollingForwardPending", - "UnprovisioningCurrent", - "RollingForwardCompleted", - "RollingBackInProgress", - "UnprovisioningTarget", - "RollingBackCompleted", - "Failed" - ], - "x-ms-enum": { - "name": "ComposeDeploymentUpgradeState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "ProvisioningTarget", - "description": "The upgrade is in the progress of provisioning target application type version. The value is 1." - }, - { - "value": "RollingForwardInProgress", - "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2." - }, - { - "value": "RollingForwardPending", - "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" - }, - { - "value": "UnprovisioningCurrent", - "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4." - }, - { - "value": "RollingForwardCompleted", - "description": "The upgrade has finished rolling forward. The value is 5." - }, - { - "value": "RollingBackInProgress", - "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6." - }, - { - "value": "UnprovisioningTarget", - "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7." - }, - { - "value": "RollingBackCompleted", - "description": "The upgrade has finished rolling back. The value is 8." - }, - { - "value": "Failed", - "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9." - } - ] - } - }, - "PagedComposeDeploymentStatusInfoList": { - "type": "object", - "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of compose deployment status information.", - "items": { - "$ref": "#/definitions/ComposeDeploymentStatusInfo" - } - } - } - }, - "CreateComposeDeploymentDescription": { - "type": "object", - "description": "Defines description for creating a Service Fabric compose deployment.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ComposeFileContent": { - "type": "string", - "description": "The content of the compose file that describes the deployment to create." - }, - "RegistryCredential": { - "$ref": "#/definitions/RegistryCredential", - "description": "Credential information to connect to container registry." - } - }, - "required": [ - "DeploymentName", - "ComposeFileContent" - ] - }, - "RegistryCredential": { - "type": "object", - "description": "Credential information to connect to container registry.", - "properties": { - "RegistryUserName": { - "type": "string", - "description": "The user name to connect to container registry." - }, - "RegistryPassword": { - "type": "string", - "description": "The password for supplied username to connect to container registry." - }, - "PasswordEncrypted": { - "type": "boolean", - "description": "Indicates that supplied container registry password is encrypted." - } - } - }, - "DeployedServicePackageInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageInfo" - }, - "description": "List of deployed service package information." - }, - "DeployedServicePackageInfo": { - "type": "object", - "description": "Information about service package deployed on a Service Fabric node.", - "properties": { - "Name": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service package as specified in the service manifest." - }, - "Version": { - "type": "string", - "description": "The version of the service package specified in service manifest." - }, - "Status": { - "$ref": "#/definitions/DeploymentStatus", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - }, - "DeploymentName": { - "type": "string", - "description": "The name of the deployment." - }, - "CorrelationSchemeList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "MoveCost": { - "type": "string", - "description": "Specifies the move cost for the service.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "MoveCost", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Zero move cost. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the move cost of the service as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the move cost of the service as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the move cost of the service as High. The value is 3." - } - ] - } - }, - "PartitionScheme": { - "type": "string", - "description": "Enumerates the ways that a service can be partitioned.", - "enum": [ - "Invalid", - "Singleton", - "UniformInt64Range", - "Named" - ], - "x-ms-enum": { - "name": "PartitionScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Singleton", - "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." - }, - { - "value": "UniformInt64Range", - "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." - }, - { - "value": "Named", - "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" - } - ] - } - }, - "ServiceCorrelationDescription": { - "type": "object", - "description": "Creates a particular correlation between services.", - "required": [ - "Scheme", - "ServiceName" - ], - "properties": { - "Scheme": { - "$ref": "#/definitions/ServiceCorrelationScheme", - "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service that the correlation relationship is established with." - } - } - }, - "ServiceCorrelationScheme": { - "type": "string", - "description": "The service correlation scheme.", - "enum": [ - "Invalid", - "Affinity", - "AlignedAffinity", - "NonAlignedAffinity" - ], - "x-ms-enum": { - "name": "ServiceCorrelationScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "An invalid correlation scheme. Cannot be used. The value is zero." - }, - { - "value": "Affinity", - "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." - }, - { - "value": "AlignedAffinity", - "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." - }, - { - "value": "NonAlignedAffinity", - "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." - } - ] - } - }, - "ServiceLoadMetricsList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceLoadMetricDescription" - }, - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServiceLoadMetricDescription": { - "type": "object", - "description": "Specifies a metric to load balance a service during runtime.", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." - }, - "Weight": { - "$ref": "#/definitions/ServiceLoadMetricWeight", - "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." - }, - "PrimaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." - }, - "SecondaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." - }, - "DefaultLoad": { - "type": "integer", - "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." - } - } - }, - "ServiceLoadMetricWeight": { - "type": "string", - "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "ServiceLoadMetricWeight", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Disables resource balancing for this metric. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the metric weight of the service load as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the metric weight of the service load as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the metric weight of the service load as High. The value is 3." - } - ] - } - }, - "ServicePackageActivationMode": { - "type": "string", - "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.", - "enum": [ - "SharedProcess", - "ExclusiveProcess" - ], - "x-ms-enum": { - "name": "ServicePackageActivationMode", - "modelAsString": true, - "values": [ - { - "value": "SharedProcess", - "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero." - }, - { - "value": "ExclusiveProcess", - "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1." - } - ] - } - }, - "ServicePlacementPoliciesList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "PartitionSchemeDescription": { - "type": "object", - "discriminator": "PartitionScheme", - "description": "Describes how the service is partitioned.", - "required": [ - "PartitionScheme" - ], - "properties": { - "PartitionScheme": { - "$ref": "#/definitions/PartitionScheme", - "description": "Specifies how the service is partitioned." - } - } - }, - "NamedPartitionSchemeDescription": { - "description": "Describes the named partition scheme of the service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "NamedPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Named", - "required": [ - "Count", - "Names" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "Names": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." - } - } - }, - "SingletonPartitionSchemeDescription": { - "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "SingletonPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "UniformInt64RangePartitionSchemeDescription": { - "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "UniformInt64RangePartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "UniformInt64Range", - "required": [ - "Count", - "LowKey", - "HighKey" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "LowKey": { - "type": "string", - "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions." - }, - "HighKey": { - "type": "string", - "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions." - } - } - }, - "ServiceDescription": { - "type": "object", - "discriminator": "ServiceKind", - "description": "A ServiceDescription contains all of the information necessary to create a service.", - "required": [ - "ServiceKind", - "ServiceName", - "ServiceTypeName", - "PartitionDescription" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The service kind." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "InitializationData": { - "$ref": "#/definitions/ByteArray", - "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created." - }, - "PartitionDescription": { - "$ref": "#/definitions/PartitionSchemeDescription", - "description": "The partition description as an object." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "CorrelationScheme": { - "$ref": "#/definitions/CorrelationSchemeList", - "description": "The correlation scheme." - }, - "ServiceLoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList", - "description": "The service placement policies." - }, - "DefaultMoveCost": { - "$ref": "#/definitions/MoveCost", - "description": "The move cost for the service." - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean", - "description": "Indicates if the DefaultMoveCost property is specified." - }, - "ServicePackageActivationMode": { - "$ref": "#/definitions/ServicePackageActivationMode", - "description": "The activation mode of service package to be used for a service." - }, - "ServiceDnsName": { - "type": "string", - "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." - }, - "ScalingPolicies": { - "$ref": "#/definitions/ScalingPolicyDescriptionList", - "description": "Scaling policies for this service." - } - } - }, - "StatefulServiceDescription": { - "description": "Describes a stateful service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - }, - { - "type": "object", - "description": "StatefulServiceDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "required": [ - "TargetReplicaSetSize", - "MinReplicaSetSize", - "HasPersistedState" - ], - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "HasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - }, - "Flags": { - "type": "integer", - "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4." - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The definition on how long StandBy replicas should be maintained before being removed." - } - } - }, - "StatelessServiceDescription": { - "description": "Describes a stateless service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - }, - { - "type": "object", - "description": "StatelessServiceDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "required": [ - "InstanceCount" - ], - "properties": { - "InstanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "ReplicatorQueueStatus": { - "type": "object", - "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.", - "properties": { - "QueueUtilizationPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full." - }, - "QueueMemorySize": { - "type": "string", - "description": "Represents the virtual memory consumed by the queue in bytes." - }, - "FirstSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue." - }, - "CompletedSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state." - }, - "CommittedSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary." - }, - "LastSequenceNumber": { - "type": "string", - "description": "Represents the latest sequence number of the operation that is available in the queue." - } - } - }, - "ReplicatorStatus": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - } - } - }, - "PrimaryReplicatorStatus": { - "x-ms-discriminator-value": "Primary", - "type": "object", - "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", - "allOf": [ - { - "$ref": "#/definitions/ReplicatorStatus" - }, - { - "type": "object", - "description": "Status of the primary replicator.", - "properties": { - "ReplicationQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the replication queue on the primary replicator." - }, - "RemoteReplicators": { - "$ref": "#/definitions/RemoteReplicatorStatusList", - "description": "The status of all the active and idle secondary replicators that the primary is aware of." - } - } - } - ] - }, - "SecondaryReplicatorStatus": { - "type": "object", - "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", - "allOf": [ - { - "$ref": "#/definitions/ReplicatorStatus" - }, - { - "type": "object", - "description": "Represents a base class for secondary replicator status.", - "properties": { - "ReplicationQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the replication queue on the secondary replicator." - }, - "LastReplicationOperationReceivedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received." - }, - "IsInBuild": { - "type": "boolean", - "description": "Value that indicates whether the replica is currently being built." - }, - "CopyQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the copy queue on the secondary replicator." - }, - "LastCopyOperationReceivedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received." - }, - "LastAcknowledgementSentTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent." - } - } - } - ] - }, - "SecondaryActiveReplicatorStatus": { - "x-ms-discriminator-value": "ActiveSecondary", - "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.", - "allOf": [ - { - "$ref": "#/definitions/SecondaryReplicatorStatus" - }, - { - "type": "object" - } - ] - }, - "SecondaryIdleReplicatorStatus": { - "x-ms-discriminator-value": "IdleSecondary", - "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.", - "allOf": [ - { - "$ref": "#/definitions/SecondaryReplicatorStatus" - }, - { - "type": "object" - } - ] - }, - "RemoteReplicatorStatus": { - "type": "object", - "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Represents the replica ID of the remote secondary replicator." - }, - "LastAcknowledgementProcessedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed." - }, - "LastReceivedReplicationSequenceNumber": { - "type": "string", - "description": "The highest replication operation sequence number that the secondary has received from the primary." - }, - "LastAppliedReplicationSequenceNumber": { - "type": "string", - "description": "The highest replication operation sequence number that the secondary has applied to its state." - }, - "IsInBuild": { - "type": "boolean", - "description": "A value that indicates whether the secondary replica is in the process of being built." - }, - "LastReceivedCopySequenceNumber": { - "type": "string", - "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations." - }, - "LastAppliedCopySequenceNumber": { - "type": "string", - "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete." - }, - "RemoteReplicatorAcknowledgementStatus": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus", - "description": "Represents the acknowledgment status for the remote secondary replicator." - } - } - }, - "RemoteReplicatorStatusList": { - "type": "array", - "items": { - "$ref": "#/definitions/RemoteReplicatorStatus" - }, - "description": "List of remote replicator status" - }, - "RemoteReplicatorAcknowledgementStatus": { - "type": "object", - "description": "Provides details about the remote replicators from the primary replicator's point of view.", - "properties": { - "ReplicationStreamAcknowledgementDetail": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", - "description": "Details about the acknowledgements for operations that are part of the replication stream data." - }, - "CopyStreamAcknowledgementDetail": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", - "description": "Details about the acknowledgements for operations that are part of the copy stream data." - } - } - }, - "RemoteReplicatorAcknowledgementDetail": { - "type": "object", - "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.", - "properties": { - "AverageReceiveDuration": { - "type": "string", - "description": "Represents the average duration it takes for the remote replicator to receive an operation." - }, - "AverageApplyDuration": { - "type": "string", - "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk." - }, - "NotReceivedCount": { - "type": "string", - "description": "Represents the number of operations not yet received by a remote replicator." - }, - "ReceivedAndNotAppliedCount": { - "type": "string", - "description": "Represents the number of operations received and not yet applied by a remote replicator." - } - } - }, - "DeployedServiceReplicaDetailInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service replica deployed on a node.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Full hierarchical name of the service in URI format starting with `fabric:`." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "CurrentServiceOperation": { - "$ref": "#/definitions/ServiceOperationName", - "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance." - }, - "CurrentServiceOperationStartTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The start time of the current service operation in UTC format." - }, - "ReportedLoad": { - "$ref": "#/definitions/LoadMetricReportInfoList", - "description": "List of load reported by replica." - } - } - }, - "DeployedStatefulServiceReplicaDetailInfo": { - "description": "Information about a stateful replica running in a code package. Please note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - }, - { - "type": "object", - "description": "DeployedStatefulServiceReplicaDetailInfo", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "CurrentReplicatorOperation": { - "$ref": "#/definitions/ReplicatorOperationName", - "description": "Specifies the operation currently being executed by the Replicator." - }, - "ReadStatus": { - "$ref": "#/definitions/PartitionAccessStatus", - "description": "Specifies the access status of the partition." - }, - "WriteStatus": { - "$ref": "#/definitions/PartitionAccessStatus", - "description": "Specifies the access status of the partition." - }, - "ReplicatorStatus": { - "$ref": "#/definitions/ReplicatorStatus", - "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc." - }, - "ReplicaStatus": { - "$ref": "#/definitions/KeyValueStoreReplicaStatus", - "description": "Key value store related information for the replica." - }, - "DeployedServiceReplicaQueryResult": { - "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo", - "description": "Information about a stateful service replica deployed on a node." - } - } - } - ] - }, - "DeployedStatelessServiceInstanceDetailInfo": { - "description": "Information about a stateless instance running in a code package. Please note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - }, - { - "type": "object", - "description": "DeployedStatelessServiceInstanceDetailInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - }, - "DeployedServiceReplicaQueryResult": { - "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo", - "description": "Information about a stateless service instance deployed on a node." - } - } - } - ] - }, - "FabricReplicaStatus": { - "type": "string", - "description": "Specifies the status of the replica.", - "enum": [ - "Invalid", - "Down", - "Up" - ], - "x-ms-enum": { - "name": "FabricReplicaStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." - }, - { - "value": "Down", - "description": "Indicates that the replica is down." - }, - { - "value": "Up", - "description": "Indicates that the replica is up." - } - ] - } - }, - "LoadMetricReportInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/LoadMetricReportInfo" - }, - "description": "List of load reported by replica." - }, - "LoadMetricReportInfo": { - "type": "object", - "description": "Information about load reported by replica.", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "Value": { - "type": "integer", - "format": "int32", - "description": "The value of the load for the metric.." - }, - "LastReportedUtc": { - "type": "string", - "format": "date-time", - "description": "The UTC time when the load is reported." - } - } - }, - "PartitionAccessStatus": { - "type": "string", - "description": "Specifies the access status of the partition.", - "enum": [ - "Invalid", - "Granted", - "ReconfigurationPending", - "NotPrimary", - "NoWriteQuorum" - ], - "x-ms-enum": { - "name": "PartitionAccessStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." - }, - { - "value": "Granted", - "description": "Indicates that the read or write operation access is granted and the operation is allowed." - }, - { - "value": "ReconfigurationPending", - "description": "Indicates that the client should try again later, because a reconfiguration is in progress." - }, - { - "value": "NotPrimary", - "description": "Indicates that this client request was received by a replica that is not a Primary replica." - }, - { - "value": "NoWriteQuorum", - "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted." - } - ] - } - }, - "ReplicatorOperationName": { - "type": "string", - "description": "Specifies the operation currently being executed by the Replicator.", - "enum": [ - "Invalid", - "None", - "Open", - "ChangeRole", - "UpdateEpoch", - "Close", - "Abort", - "OnDataLoss", - "WaitForCatchup", - "Build" - ], - "x-ms-enum": { - "name": "ReplicatorOperationName", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Default value if the replicator is not yet ready." - }, - { - "value": "None", - "description": "Replicator is not running any operation from Service Fabric perspective." - }, - { - "value": "Open", - "description": "Replicator is opening." - }, - { - "value": "ChangeRole", - "description": "Replicator is in the process of changing its role." - }, - { - "value": "UpdateEpoch", - "description": "Due to a change in the replica set, replicator is being updated with its Epoch." - }, - { - "value": "Close", - "description": "Replicator is closing." - }, - { - "value": "Abort", - "description": "Replicator is being aborted." - }, - { - "value": "OnDataLoss", - "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source." - }, - { - "value": "WaitForCatchup", - "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state." - }, - { - "value": "Build", - "description": "Replicator is in the process of building one or more replicas." - } - ] - } - }, - "ServiceOperationName": { - "type": "string", - "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.", - "enum": [ - "Unknown", - "None", - "Open", - "ChangeRole", - "Close", - "Abort" - ], - "x-ms-enum": { - "name": "ServiceOperationName", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Reserved for future use." - }, - { - "value": "None", - "description": "The service replica or instance is not going through any life-cycle changes." - }, - { - "value": "Open", - "description": "The service replica or instance is being opened." - }, - { - "value": "ChangeRole", - "description": "The service replica is changing roles." - }, - { - "value": "Close", - "description": "The service replica or instance is being closed." - }, - { - "value": "Abort", - "description": "The service replica or instance is being aborted." - } - ] - } - }, - "ReplicaKind": { - "type": "string", - "description": "The role of a replica of a stateful service.", - "enum": [ - "Invalid", - "KeyValueStore" - ], - "x-ms-enum": { - "name": "ReplicaKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Represents an invalid replica kind. The value is zero." - }, - { - "value": "KeyValueStore", - "description": "Represents a key value store replica. The value is 1" - } - ] - } - }, - "ReplicaStatusBase": { - "type": "object", - "discriminator": "Kind", - "description": "Information about the replica.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ReplicaKind", - "description": "The role of a replica of a stateful service." - } - } - }, - "KeyValueStoreReplicaStatus": { - "description": "Key value store related information for the replica.", - "x-ms-discriminator-value": "KeyValueStore", - "allOf": [ - { - "$ref": "#/definitions/ReplicaStatusBase" - }, - { - "type": "object", - "description": "KeyValueStoreReplicaStatus", - "properties": { - "DatabaseRowCountEstimate": { - "type": "string", - "description": "Value indicating the estimated number of rows in the underlying database." - }, - "DatabaseLogicalSizeEstimate": { - "type": "string", - "description": "Value indicating the estimated size of the underlying database." - }, - "CopyNotificationCurrentKeyFilter": { - "type": "string", - "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback." - }, - "CopyNotificationCurrentProgress": { - "type": "string", - "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback." - }, - "StatusDetails": { - "type": "string", - "description": "Value indicating the current status details of the replica." - } - } - } - ] - }, - "ServiceUpdateDescription": { - "type": "object", - "discriminator": "ServiceKind", - "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The service kind." - }, - "Flags": { - "type": "string", - "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "CorrelationScheme": { - "$ref": "#/definitions/CorrelationSchemeList", - "description": "The correlation scheme." - }, - "LoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList", - "description": "The service placement policies." - }, - "DefaultMoveCost": { - "$ref": "#/definitions/MoveCost", - "description": "The move cost for the service." - }, - "ScalingPolicies": { - "$ref": "#/definitions/ScalingPolicyDescriptionList", - "description": "Scaling policies for this service." - } - } - }, - "StatefulServiceUpdateDescription": { - "description": "Describes an update for a stateful service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - }, - { - "type": "object", - "description": "StatefulServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "string", - "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." - }, - "QuorumLossWaitDurationSeconds": { - "type": "string", - "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." - }, - "StandByReplicaKeepDurationSeconds": { - "type": "string", - "description": "The definition on how long StandBy replicas should be maintained before being removed." - } - } - }, - "StatelessServiceUpdateDescription": { - "description": "Describes an update for a stateless service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - }, - { - "type": "object", - "description": "StatelessServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "InstanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "ImageStoreRelativePath": { - "type": "string", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "FileVersion": { - "type": "object", - "description": "Information about the version of image store file.", - "properties": { - "VersionNumber": { - "type": "string", - "description": "The current image store version number for the file is used in image store for checking whether it need to be updated." - }, - "EpochDataLossNumber": { - "type": "string", - "description": "The epoch data loss number of image store replica when this file entry was updated or created." - }, - "EpochConfigurationNumber": { - "type": "string", - "description": "The epoch configuration version number of the image store replica when this file entry was created or updated." - } - } - }, - "FileInfo": { - "type": "object", - "description": "Information about a image store file.", - "properties": { - "FileSize": { - "type": "string", - "description": "The size of file in bytes." - }, - "FileVersion": { - "$ref": "#/definitions/FileVersion", - "description": "Information about the version of image store file." - }, - "ModifiedDate": { - "type": "string", - "format": "date-time", - "description": "The date and time when the image store file was last modified." - }, - "StoreRelativePath": { - "type": "string", - "description": "The file path relative to the image store root path." - } - } - }, - "FolderInfo": { - "type": "object", - "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.", - "properties": { - "StoreRelativePath": { - "$ref": "#/definitions/ImageStoreRelativePath", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "FileCount": { - "type": "string", - "description": "The number of files from within the image store folder." - } - } - }, - "ImageStoreContent": { - "type": "object", - "description": "Information about the image store content.", - "properties": { - "StoreFiles": { - "type": "array", - "items": { - "$ref": "#/definitions/FileInfo" - }, - "description": "The list of image store file info objects represents files found under the given image store relative path." - }, - "StoreFolders": { - "type": "array", - "items": { - "$ref": "#/definitions/FolderInfo" - }, - "description": "The list of image store folder info objects represents subfolders found under the given image store relative path." - } - } - }, - "ImageStoreCopyDescription": { - "type": "object", - "description": "Information about how to copy image store content from one image store relative path to another image store relative path.", - "required": [ - "RemoteSource", - "RemoteDestination" - ], - "properties": { - "RemoteSource": { - "type": "string", - "description": "The relative path of source image store content to be copied from." - }, - "RemoteDestination": { - "type": "string", - "description": "The relative path of destination image store content to be copied to." - }, - "SkipFiles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of the file names to be skipped for copying." - }, - "CheckMarkFile": { - "type": "boolean", - "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped." - } - } - }, - "InstanceId": { - "type": "string", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - }, - "CodePackageInstanceId": { - "type": "string", - "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." - }, - "HostIsolationMode": { - "type": "string", - "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.", - "enum": [ - "None", - "Process", - "HyperV" - ], - "x-ms-enum": { - "name": "HostIsolationMode", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0." - }, - { - "value": "Process", - "description": "This is the default isolation mode for a ContainerHost. The value is 1." - }, - { - "value": "HyperV", - "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2." - } - ] - } - }, - "HostType": { - "type": "string", - "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.", - "enum": [ - "Invalid", - "ExeHost", - "ContainerHost" - ], - "x-ms-enum": { - "name": "HostType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the type of host is not known or invalid. The value is 0." - }, - { - "value": "ExeHost", - "description": "Indicates the host is an executable. The value is 1." - }, - { - "value": "ContainerHost", - "description": "Indicates the host is a container. The value is 2." - } - ] - } - }, - "RestartDeployedCodePackageDescription": { - "type": "object", - "description": "Defines description for restarting a deployed code package on Service Fabric node.", - "required": [ - "ServiceManifestName", - "CodePackageName", - "CodePackageInstanceId" - ], - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest that specified this code package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package defined in the service manifest." - }, - "CodePackageInstanceId": { - "$ref": "#/definitions/CodePackageInstanceId", - "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package." - } - } - }, - "DeployedServiceTypeInfo": { - "type": "object", - "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.", - "properties": { - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package that registered the service type." - }, - "Status": { - "$ref": "#/definitions/ServiceTypeRegistrationStatus", - "description": "The status of the service type registration on the node." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - }, - "DeployedServiceTypeInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServiceTypeInfo" - }, - "description": "List of information about service type deployed on a node." - }, - "ServiceTypeRegistrationStatus": { - "type": "string", - "description": "The status of the service type registration on the node.", - "enum": [ - "Invalid", - "Disabled", - "Enabled", - "Registered" - ], - "x-ms-enum": { - "name": "ServiceTypeRegistrationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Disabled", - "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1." - }, - { - "value": "Enabled", - "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2." - }, - { - "value": "Registered", - "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3." - } - ] - } - }, - "ServiceEndpointRole": { - "type": "string", - "description": "The role of the replica where the endpoint is reported.", - "enum": [ - "Invalid", - "Stateless", - "StatefulPrimary", - "StatefulSecondary" - ], - "x-ms-enum": { - "name": "ServiceEndpointRole", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Stateless", - "description": "Indicates that the service endpoint is of a stateless service. The value is 1." - }, - { - "value": "StatefulPrimary", - "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2." - }, - { - "value": "StatefulSecondary", - "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3." - } - ] - } - }, - "ResolvedServiceEndpoint": { - "type": "object", - "description": "Endpoint of a resolved service partition.", - "properties": { - "Kind": { - "$ref": "#/definitions/ServiceEndpointRole", - "description": "The role of the replica where the endpoint is reported." - }, - "Address": { - "type": "string", - "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener." - } - } - }, - "ResolvedServicePartition": { - "type": "object", - "description": "Information about a service partition and its associated endpoints.", - "required": [ - "Name", - "PartitionInformation", - "Endpoints", - "Version" - ], - "properties": { - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "A representation of the resolved partition." - }, - "Endpoints": { - "$ref": "#/definitions/ResolvedServiceEndpointList", - "description": "List of resolved service endpoints of a service partition." - }, - "Version": { - "type": "string", - "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter." - } - } - }, - "ResolvedServiceEndpointList": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolvedServiceEndpoint" - }, - "description": "List of resolved service endpoints of a service partition." - }, - "InvokeDataLossResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "InvokeQuorumLossResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "NodeResult": { - "type": "object", - "description": "Contains information about a node that was targeted by a user-induced operation.", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "NodeInstanceId": { - "type": "string", - "description": "The node instance id." - } - } - }, - "NodeTransitionProgress": { - "type": "object", - "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "NodeTransitionResult": { - "$ref": "#/definitions/NodeTransitionResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "NodeTransitionResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "NodeResult": { - "$ref": "#/definitions/NodeResult", - "description": "Contains information about a node that was targeted by a user-induced operation." - } - } - }, - "OperationId": { - "type": "string", - "format": "uuid", - "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." - }, - "OperationState": { - "type": "string", - "description": "The state of the operation.", - "enum": [ - "Invalid", - "Running", - "RollingBack", - "Completed", - "Faulted", - "Cancelled", - "ForceCancelled" - ], - "x-ms-enum": { - "name": "OperationState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The operation state is invalid." - }, - { - "value": "Running", - "description": "The operation is in progress." - }, - { - "value": "RollingBack", - "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command." - }, - { - "value": "Completed", - "description": "The operation has completed successfully and is no longer running." - }, - { - "value": "Faulted", - "description": "The operation has failed and is no longer running." - }, - { - "value": "Cancelled", - "description": "The operation was cancelled by the user using CancelOperation, and is no longer running." - }, - { - "value": "ForceCancelled", - "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details." - } - ] - } - }, - "OperationStatus": { - "type": "object", - "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.", - "properties": { - "OperationId": { - "$ref": "#/definitions/OperationId", - "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." - }, - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "Type": { - "$ref": "#/definitions/OperationType", - "description": "The type of the operation." - } - } - }, - "OperationStatusList": { - "type": "array", - "description": "A list of OperationStatus objects.", - "items": { - "$ref": "#/definitions/OperationStatus" - } - }, - "OperationType": { - "type": "string", - "description": "The type of the operation.", - "enum": [ - "Invalid", - "PartitionDataLoss", - "PartitionQuorumLoss", - "PartitionRestart", - "NodeTransition" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The operation state is invalid." - }, - { - "value": "PartitionDataLoss", - "description": "An operation started using the StartDataLoss API." - }, - { - "value": "PartitionQuorumLoss", - "description": "An operation started using the StartQuorumLoss API." - }, - { - "value": "PartitionRestart", - "description": "An operation started using the StartPartitionRestart API." - }, - { - "value": "NodeTransition", - "description": "An operation started using the StartNodeTransition API." - } - ] - } - }, - "PartitionDataLossProgress": { - "type": "object", - "description": "Information about a partition data loss user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "InvokeDataLossResult": { - "$ref": "#/definitions/InvokeDataLossResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "PartitionQuorumLossProgress": { - "type": "object", - "description": "Information about a partition quorum loss user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "InvokeQuorumLossResult": { - "$ref": "#/definitions/InvokeQuorumLossResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "PartitionRestartProgress": { - "type": "object", - "description": "Information about a partition restart user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "RestartPartitionResult": { - "$ref": "#/definitions/RestartPartitionResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "RestartPartitionResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "SelectedPartition": { - "type": "object", - "description": "This class returns information about the partition that the user-induced operation acted upon.", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service the partition belongs to." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - }, - "DeployServicePackageToNodeDescription": { - "type": "object", - "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.", - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest whose packages need to be downloaded." - }, - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "PackageSharingPolicy": { - "$ref": "#/definitions/PackageSharingPolicyInfoList", - "description": "List of package sharing policy information." - } - }, - "required": [ - "ServiceManifestName", - "ApplicationTypeName", - "ApplicationTypeVersion", - "NodeName" - ] - }, - "PackageSharingPolicyInfo": { - "type": "object", - "description": "Represents a policy for the package sharing.", - "properties": { - "SharedPackageName": { - "type": "string", - "description": "The name of code, configuration or data package that should be shared." - }, - "PackageSharingScope": { - "$ref": "#/definitions/PackageSharingPolicyScope", - "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation." - } - } - }, - "PackageSharingPolicyInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/PackageSharingPolicyInfo" - }, - "description": "List of package sharing policy information." - }, - "PackageSharingPolicyScope": { - "type": "string", - "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.", - "enum": [ - "None", - "All", - "Code", - "Config", - "Data" - ], - "x-ms-enum": { - "name": "PackageSharingPolicyScope", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No package sharing policy scope. The value is 0." - }, - { - "value": "All", - "description": "Share all code, config and data packages from corresponding service manifest. The value is 1." - }, - { - "value": "Code", - "description": "Share all code packages from corresponding service manifest. The value is 2." - }, - { - "value": "Config", - "description": "Share all config packages from corresponding service manifest. The value is 3." - }, - { - "value": "Data", - "description": "Share all data packages from corresponding service manifest. The value is 4." - } - ] - } - }, - "ResumeApplicationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "The name of the upgrade domain in which to resume the upgrade." - } - }, - "required": [ - "UpgradeDomainName" - ] - }, - "ApplicationUpgradeUpdateDescription": { - "type": "object", - "description": "Describes the parameters for updating an ongoing application upgrade.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - }, - "UpdateDescription": { - "$ref": "#/definitions/RollingUpgradeUpdateDescription", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster." - } - }, - "required": [ - "Name", - "UpgradeKind" - ] - }, - "RollingUpgradeUpdateDescription": { - "type": "object", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster.", - "properties": { - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "ReplicaSetCheckTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "FailureAction": { - "$ref": "#/definitions/FailureAction", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." - }, - "HealthCheckWaitDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckWaitDuration", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckStableDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckStableDuration", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "$ref": "#/definitions/HealthCheckRetryTimeout", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeTimeout", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeDomainTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainTimeout", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - } - }, - "required": [ - "RollingUpgradeMode" - ] - }, - "NameDescription": { - "type": "object", - "description": "Describes a Service Fabric name.", - "properties": { - "Name": { - "$ref": "#/definitions/FabricName", - "description": "The Service Fabric name, including the 'fabric:' URI scheme." - } - }, - "required": [ - "Name" - ] - }, - "FabricName": { - "type": "string", - "description": "The Service Fabric name, including the 'fabric:' URI scheme." - }, - "PagedSubNameInfoList": { - "type": "object", - "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "IsConsistent": { - "type": "boolean", - "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false." - }, - "SubNames": { - "type": "array", - "description": "List of the child names.", - "items": { - "$ref": "#/definitions/FabricName" - } - } - } - }, - "PropertyValueKind": { - "type": "string", - "description": "The kind of property, determined by the type of data. Following are the possible values.", - "enum": [ - "Invalid", - "Binary", - "Int64", - "Double", - "String", - "Guid" - ], - "x-ms-enum": { - "name": "PropertyValueKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Binary", - "description": "The data inside the property is a binary blob. The value is 1." - }, - { - "value": "Int64", - "description": "The data inside the property is an int64. The value is 2." - }, - { - "value": "Double", - "description": "The data inside the property is a double. The value is 3." - }, - { - "value": "String", - "description": "The data inside the property is a string. The value is 4." - }, - { - "value": "Guid", - "description": "The data inside the property is a guid. The value is 5." - } - ] - } - }, - "PropertyValue": { - "type": "object", - "discriminator": "Kind", - "description": "Describes a Service Fabric property value.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyValueKind", - "description": "The kind of property, determined by the type of data. Following are the possible values." - } - }, - "required": [ - "Kind" - ] - }, - "BinaryPropertyValue": { - "description": "Describes a Service Fabric property value of type Binary.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "BinaryPropertyValue" - } - ], - "x-ms-discriminator-value": "Binary", - "required": [ - "Data" - ], - "properties": { - "Data": { - "$ref": "#/definitions/ByteArray", - "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255." - } - } - }, - "Int64PropertyValue": { - "description": "Describes a Service Fabric property value of type Int64.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "Int64PropertyValue" - } - ], - "x-ms-discriminator-value": "Int64", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "description": "The data of the property value." - } - } - }, - "DoublePropertyValue": { - "description": "Describes a Service Fabric property value of type Double.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "DoublePropertyValue" - } - ], - "x-ms-discriminator-value": "Double", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "number", - "format": "double", - "description": "The data of the property value." - } - } - }, - "StringPropertyValue": { - "description": "Describes a Service Fabric property value of type String.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "StringPropertyValue" - } - ], - "x-ms-discriminator-value": "String", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "description": "The data of the property value." - } - } - }, - "GuidPropertyValue": { - "description": "Describes a Service Fabric property value of type Guid.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "GuidPropertyValue" - } - ], - "x-ms-discriminator-value": "Guid", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "format": "uuid", - "description": "The data of the property value." - } - } - }, - "PropertyInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Information about a Service Fabric property.", - "properties": { - "Name": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - }, - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - }, - "Metadata": { - "$ref": "#/definitions/PropertyMetadata", - "description": "The metadata associated with a property, including the property's name." - } - }, - "required": [ - "Name", - "Metadata" - ] - }, - "PagedPropertyInfoList": { - "type": "object", - "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "IsConsistent": { - "type": "boolean", - "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false." - }, - "Properties": { - "type": "array", - "description": "List of property information.", - "items": { - "$ref": "#/definitions/PropertyInfo" - } - } - } - }, - "PropertyDescription": { - "type": "object", - "description": "Description of a Service Fabric property.", - "properties": { - "PropertyName": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." - }, - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - } - }, - "required": [ - "PropertyName", - "Value" - ] - }, - "PropertyName": { - "type": "string", - "description": "The name of the Service Fabric property." - }, - "PropertyMetadata": { - "type": "object", - "description": "The metadata associated with a property, including the property's name.", - "properties": { - "TypeId": { - "$ref": "#/definitions/PropertyValueKind", - "description": "The kind of property, determined by the type of data. Following are the possible values." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type id." - }, - "Parent": { - "$ref": "#/definitions/FabricName", - "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the namespace/table under which the property exists." - }, - "SizeInBytes": { - "type": "integer", - "description": "The length of the serialized property value." - }, - "LastModifiedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated." - }, - "SequenceNumber": { - "type": "string", - "description": "The version of the property. Every time a property is modified, its sequence number is increased." - } - } - }, - "PropertyCustomTypeId": { - "type": "string", - "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." - }, - "PropertyBatchDescriptionList": { - "type": "object", - "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.", - "properties": { - "Operations": { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyBatchOperation" - }, - "description": "A list of the property batch operations to be executed." - } - } - }, - "PropertyBatchOperationKind": { - "type": "string", - "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.", - "enum": [ - "Invalid", - "Put", - "Get", - "CheckExists", - "CheckSequence", - "Delete", - "CheckValue" - ], - "x-ms-enum": { - "name": "PropertyBatchOperationKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Put", - "description": "The operation will create or edit a property. The value is 1." - }, - { - "value": "Get", - "description": "The operation will get a property. The value is 2." - }, - { - "value": "CheckExists", - "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3." - }, - { - "value": "CheckSequence", - "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4." - }, - { - "value": "Delete", - "description": "The operation will delete a property. The value is 5." - }, - { - "value": "CheckValue", - "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7." - } - ] - } - }, - "PropertyBatchOperation": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the base type for property operations that can be put into a batch and submitted.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyBatchOperationKind", - "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values." - }, - "PropertyName": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - } - }, - "required": [ - "Kind", - "PropertyName" - ] - }, - "CheckExistsPropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckExistsPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckExists", - "properties": { - "Exists": { - "type": "boolean", - "description": "Whether or not the property should exist for the operation to pass." - } - }, - "required": [ - "Exists" - ] - }, - "CheckSequencePropertyBatchOperation": { - "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckSequencePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckSequence", - "properties": { - "SequenceNumber": { - "type": "string", - "description": "The expected sequence number." - } - }, - "required": [ - "SequenceNumber" - ] - }, - "CheckValuePropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckValuePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckValue", - "properties": { - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "The expected property value." - } - }, - "required": [ - "Value" - ] - }, - "DeletePropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "DeletePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Delete" - }, - "GetPropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "GetPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Get", - "properties": { - "IncludeValue": { - "type": "boolean", - "default": false, - "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata." - } - } - }, - "PutPropertyBatchOperation": { - "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "PutPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Put", - "properties": { - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." - } - }, - "required": [ - "Value" - ] - }, - "PropertyBatchInfoKind": { - "type": "string", - "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.", - "enum": [ - "Invalid", - "Successful", - "Failed" - ], - "x-ms-enum": { - "name": "PropertyBatchInfoKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Successful", - "description": "The property batch succeeded." - }, - { - "value": "Failed", - "description": "The property batch failed." - } - ] - } - }, - "PropertyBatchInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Information about the results of a property batch.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyBatchInfoKind", - "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values." - } - }, - "required": [ - "Kind" - ] - }, - "SuccessfulPropertyBatchInfo": { - "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchInfo" - }, - { - "type": "object", - "description": "SuccessfulPropertyBatchInfo" - } - ], - "x-ms-discriminator-value": "Successful", - "properties": { - "Properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PropertyInfo" - }, - "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map." - } - } - }, - "FailedPropertyBatchInfo": { - "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchInfo" - }, - { - "type": "object", - "description": "FailedPropertyBatchInfo" - } - ], - "x-ms-discriminator-value": "Failed", - "properties": { - "ErrorMessage": { - "type": "string", - "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch." - }, - "OperationIndex": { - "type": "integer", - "description": "The index of the unsuccessful operation in the property batch." - } - } - }, - "EntityKind": { - "type": "string", - "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", - "enum": [ - "Invalid", - "Node", - "Partition", - "Service", - "Application", - "Replica", - "DeployedApplication", - "DeployedServicePackage", - "Cluster" - ], - "x-ms-enum": { - "name": "EntityKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Node", - "description": "Indicates the entity is a Service Fabric node. The value is 1." - }, - { - "value": "Partition", - "description": "Indicates the entity is a Service Fabric partition. The value is 2." - }, - { - "value": "Service", - "description": "Indicates the entity is a Service Fabric service. The value is 3." - }, - { - "value": "Application", - "description": "Indicates the entity is a Service Fabric application. The value is 4." - }, - { - "value": "Replica", - "description": "Indicates the entity is a Service Fabric replica. The value is 5." - }, - { - "value": "DeployedApplication", - "description": "Indicates the entity is a Service Fabric deployed application. The value is 6." - }, - { - "value": "DeployedServicePackage", - "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7." - }, - { - "value": "Cluster", - "description": "Indicates the entity is a Service Fabric cluster. The value is 8." - } - ] - } - }, - "HealthStateCount": { - "type": "object", - "description": "Represents information about how many health entities are in Ok, Warning and Error health state.", - "properties": { - "OkCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Ok.", - "minimum": 0 - }, - "WarningCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Warning.", - "minimum": 0 - }, - "ErrorCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Error.", - "minimum": 0 - } - } - }, - "EntityKindHealthStateCount": { - "type": "object", - "description": "Represents health state count for entities of the specified entity kind.", - "properties": { - "EntityKind": { - "$ref": "#/definitions/EntityKind", - "description": "The entity kind for which health states are evaluated." - }, - "HealthStateCount": { - "$ref": "#/definitions/HealthStateCount", - "description": "The health state count for the entities of the specified kind." - } - } - }, - "HealthStatistics": { - "type": "object", - "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.", - "properties": { - "HealthStateCountList": { - "type": "array", - "items": { - "$ref": "#/definitions/EntityKindHealthStateCount" - }, - "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state." - } - } - }, - "BackupPolicyDescription": { - "type": "object", - "description": "Describes a backup policy for configuring periodic backup.", - "required": [ - "Name", - "AutoRestoreOnDataLoss", - "Schedule", - "MaxIncrementalBackups", - "Storage" - ], - "properties": { - "Name": { - "type": "string", - "description": "The unique name identifying this backup policy." - }, - "AutoRestoreOnDataLoss": { - "type": "boolean", - "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event." - }, - "MaxIncrementalBackups": { - "type": "integer", - "minimum": 0, - "maximum": 255, - "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit." - }, - "Schedule": { - "$ref": "#/definitions/BackupScheduleDescription", - "description": "Describes the backup schedule parameters." - }, - "Storage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Describes the details of backup storage where to store the periodic backups." - } - } - }, - "PagedBackupPolicyDescriptionList": { - "type": "object", - "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "The list of backup policies information.", - "items": { - "$ref": "#/definitions/BackupPolicyDescription" - } - } - } - }, - "BackupStorageDescription": { - "type": "object", - "required": [ - "StorageKind" - ], - "discriminator": "StorageKind", - "properties": { - "StorageKind": { - "$ref": "#/definitions/BackupStorageKind", - "description": "The kind of backup storage, where backups are saved." - }, - "FriendlyName": { - "type": "string", - "description": "Friendly name for this backup storage." - } - }, - "description": "Describes the parameters for the backup storage." - }, - "BackupStorageKind": { - "type": "string", - "description": "The kind of backup storage, where backups are saved.", - "enum": [ - "Invalid", - "FileShare", - "AzureBlobStore" - ], - "x-ms-enum": { - "name": "BackupStorageKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "FileShare", - "description": "Indicates file/ SMB share to be used as backup storage." - }, - { - "value": "AzureBlobStore", - "description": "Indicates Azure blob store to be used as backup storage." - } - ] - } - }, - "BackupScheduleDescription": { - "type": "object", - "description": "Describes the backup schedule parameters.", - "required": [ - "ScheduleKind" - ], - "discriminator": "ScheduleKind", - "properties": { - "ScheduleKind": { - "$ref": "#/definitions/BackupScheduleKind", - "description": "The kind of backup schedule, time based or frequency based." - } - } - }, - "BackupScheduleKind": { - "type": "string", - "description": "The kind of backup schedule, time based or frequency based.", - "enum": [ - "Invalid", - "TimeBased", - "FrequencyBased" - ], - "x-ms-enum": { - "name": "BackupScheduleKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "TimeBased", - "description": "Indicates a time-based backup schedule." - }, - { - "value": "FrequencyBased", - "description": "Indicates a frequency-based backup schedule." - } - ] - } - }, - "ApplicationBackupConfigurationInfo": { - "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Application backup configuration information.", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Application" - }, - "ServiceBackupConfigurationInfo": { - "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Service backup configuration info", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Service" - }, - "PagedBackupConfigurationInfoList": { - "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup configuration information.", - "items": { - "$ref": "#/definitions/BackupConfigurationInfo" - } - } - } - }, - "BackupPolicyScope": { - "type": "string", - "description": "Specifies the scope at which the backup policy is applied.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupPolicyScope", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level." - }, - { - "value": "Service", - "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level." - }, - { - "value": "Application", - "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level." - } - ] - } - }, - "BackupSuspensionScope": { - "type": "string", - "description": "Specifies the scope at which the backup suspension was applied.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupSuspensionScope", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the backup suspension is applied at partition level." - }, - { - "value": "Service", - "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup." - }, - { - "value": "Application", - "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup." - } - ] - } - }, - "RestorePartitionDescription": { - "type": "object", - "description": "Specifies the parameters needed to trigger a restore of a specific partition.", - "required": [ - "BackupId", - "BackupLocation" - ], - "properties": { - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique backup ID." - }, - "BackupLocation": { - "type": "string", - "description": "Location of the backup relative to the backup storage specified/ configured." - }, - "BackupStorage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Location of the backup from where the partition will be restored." - } - } - }, - "RestoreProgressInfo": { - "type": "object", - "description": "Describes the progress of a restore operation on a partition.", - "properties": { - "RestoreState": { - "$ref": "#/definitions/RestoreState", - "description": "Represents the current state of the partition restore operation." - }, - "TimeStampUtc": { - "type": "string", - "format": "date-time", - "description": "Timestamp when operation succeeded or failed." - }, - "RestoredEpoch": { - "$ref": "#/definitions/BackupEpoch", - "description": "Describes the epoch at which the partition is restored." - }, - "RestoredLsn": { - "type": "string", - "description": "Restored LSN." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in performing restore operation." - } - } - }, - "RestoreState": { - "type": "string", - "description": "Represents the current state of the partition restore operation.", - "enum": [ - "Invalid", - "Accepted", - "RestoreInProgress", - "Success", - "Failure", - "Timeout" - ], - "x-ms-enum": { - "name": "RestoreState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Accepted", - "description": "Operation has been validated and accepted. Restore is yet to be triggered." - }, - { - "value": "RestoreInProgress", - "description": "Restore operation has been triggered and is under process." - }, - { - "value": "Success", - "description": "Operation completed with success." - }, - { - "value": "Failure", - "description": "Operation completed with failure." - }, - { - "value": "Timeout", - "description": "Operation timed out." - } - ] - } - }, - "BackupPartitionDescription": { - "type": "object", - "description": "Describes the parameters for triggering partition's backup.", - "properties": { - "BackupStorage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Specifies the details of the backup storage where to save the backup." - } - } - }, - "BackupInfo": { - "type": "object", - "description": "Represents a backup point which can be used to trigger a restore.", - "properties": { - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique backup ID ." - }, - "BackupChainId": { - "type": "string", - "format": "uuid", - "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups." - }, - "ApplicationName": { - "type": "string", - "description": "Name of the Service Fabric application this partition backup belongs to." - }, - "ServiceName": { - "type": "string", - "description": "Name of the Service Fabric service this partition backup belongs to." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "Information about the partition to which this backup belongs to" - }, - "BackupLocation": { - "type": "string", - "description": "Location of the backup, relative to the backup store." - }, - "BackupType": { - "$ref": "#/definitions/BackupType", - "description": "Describes the type of backup, whether its full or incremental." - }, - "EpochOfLastBackupRecord": { - "$ref": "#/definitions/BackupEpoch", - "description": "Epoch of the last record in this backup." - }, - "LsnOfLastBackupRecord": { - "type": "string", - "description": "LSN of the last record in this backup." - }, - "CreationTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The date time when this backup was taken." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in getting backup point information." - } - } - }, - "PagedBackupInfoList": { - "type": "object", - "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup information.", - "items": { - "$ref": "#/definitions/BackupInfo" - } - } - } - }, - "BackupType": { - "type": "string", - "description": "Describes the type of backup, whether its full or incremental.", - "enum": [ - "Invalid", - "Full", - "Incremental" - ], - "x-ms-enum": { - "name": "BackupType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Full", - "description": "Indicates a full backup." - }, - { - "value": "Incremental", - "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups." - } - ] - } - }, - "AzureBlobBackupStorageDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BackupStorageDescription" - }, - { - "type": "object" - }, - { - "description": "AzureBlobBackupStorageDescription" - } - ], - "x-ms-discriminator-value": "AzureBlobStore", - "required": [ - "ConnectionString", - "ContainerName" - ], - "properties": { - "ConnectionString": { - "type": "string", - "description": "The connection string to connect to the Azure blob store." - }, - "ContainerName": { - "type": "string", - "description": "The name of the container in the blob store to store and enumerate backups from." - } - }, - "description": "Describes the parameters for Azure blob store used for storing and enumerating backups." - }, - "FileShareBackupStorageDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BackupStorageDescription" - }, - { - "type": "object" - }, - { - "description": "FileShareBackupStorageDescription" - } - ], - "x-ms-discriminator-value": "FileShare", - "required": [ - "Path" - ], - "description": "Describes the parameters for file share storage used for storing or enumerating backups.", - "properties": { - "Path": { - "type": "string", - "description": "UNC path of the file share where to store or enumerate backups from." - }, - "PrimaryUserName": { - "type": "string", - "description": "Primary user name to access the file share." - }, - "PrimaryPassword": { - "type": "string", - "description": "Primary password to access the share location." - }, - "SecondaryUserName": { - "type": "string", - "description": "Secondary user name to access the file share." - }, - "SecondaryPassword": { - "type": "string", - "description": "Secondary password to access the share location" - } - } - }, - "FrequencyBasedBackupScheduleDescription": { - "type": "object", - "description": "Describes the frequency based backup schedule.", - "allOf": [ - { - "$ref": "#/definitions/BackupScheduleDescription" - }, - { - "type": "object" - }, - { - "description": "FrequencyBasedBackupScheduleDescription" - } - ], - "x-ms-discriminator-value": "FrequencyBased", - "required": [ - "Interval" - ], - "properties": { - "Interval": { - "type": "string", - "format": "duration", - "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy." - } - } - }, - "TimeBasedBackupScheduleDescription": { - "type": "object", - "description": "Describes the time based backup schedule.", - "allOf": [ - { - "$ref": "#/definitions/BackupScheduleDescription" - }, - { - "type": "object" - }, - { - "description": "TimeBasedBackupScheduleDescription" - } - ], - "x-ms-discriminator-value": "TimeBased", - "required": [ - "ScheduleFrequencyType", - "RunTimes" - ], - "properties": { - "ScheduleFrequencyType": { - "$ref": "#/definitions/BackupScheduleFrequencyType", - "description": "Describes the frequency with which to run the time based backup schedule." - }, - "RunDays": { - "$ref": "#/definitions/DayOfWeekList", - "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." - }, - "RunTimes": { - "$ref": "#/definitions/TimeList", - "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." - } - } - }, - "BackupScheduleFrequencyType": { - "type": "string", - "description": "Describes the frequency with which to run the time based backup schedule.", - "enum": [ - "Invalid", - "Daily", - "Weekly" - ], - "x-ms-enum": { - "name": "BackupScheduleFrequencyType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Daily", - "description": "Indicates that the time based backup schedule is repeated at a daily frequency." - }, - { - "value": "Weekly", - "description": "Indicates that the time based backup schedule is repeated at a weekly frequency." - } - ] - } - }, - "TimeList": { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." - }, - "DayOfWeekList": { - "type": "array", - "items": { - "$ref": "#/definitions/DayOfWeek" - }, - "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." - }, - "DayOfWeek": { - "type": "string", - "description": "Describes the days in a week.", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": true, - "values": [ - { - "value": "Sunday", - "description": "Indicates the Day referred is Sunday." - }, - { - "value": "Monday", - "description": "Indicates the Day referred is Monday." - }, - { - "value": "Tuesday", - "description": "Indicates the Day referred is Tuesday." - }, - { - "value": "Wednesday", - "description": "Indicates the Day referred is Wednesday." - }, - { - "value": "Thursday", - "description": "Indicates the Day referred is Thursday." - }, - { - "value": "Friday", - "description": "Indicates the Day referred is Friday." - }, - { - "value": "Saturday", - "description": "Indicates the Day referred is Saturday." - } - ] - } - }, - "BackupProgressInfo": { - "type": "object", - "description": "Describes the progress of a partition's backup.", - "properties": { - "BackupState": { - "$ref": "#/definitions/BackupState", - "description": "Represents the current state of the partition backup operation." - }, - "TimeStampUtc": { - "type": "string", - "format": "date-time", - "description": "TimeStamp in UTC when operation succeeded or failed." - }, - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique ID of the newly created backup." - }, - "BackupLocation": { - "type": "string", - "description": "Location, relative to the backup store, of the newly created backup." - }, - "EpochOfLastBackupRecord": { - "$ref": "#/definitions/BackupEpoch", - "description": "Specifies the epoch of the last record included in backup." - }, - "LsnOfLastBackupRecord": { - "type": "string", - "description": "The LSN of last record included in backup." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in performing backup operation." - } - } - }, - "BackupConfigurationInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the backup configuration information.", - "properties": { - "Kind": { - "$ref": "#/definitions/BackupEntityKind", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." - }, - "PolicyName": { - "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.", - "type": "string" - }, - "PolicyInheritedFrom": { - "$ref": "#/definitions/BackupPolicyScope", - "description": "Specifies the scope at which the backup policy is applied." - }, - "SuspensionInfo": { - "$ref": "#/definitions/BackupSuspensionInfo", - "description": "Describes the backup suspension details." - } - }, - "required": [ - "Kind" - ] - }, - "PartitionBackupConfigurationInfo": { - "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Partition backup configuration info", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - } - ], - "x-ms-discriminator-value": "Partition" - }, - "BackupState": { - "type": "string", - "description": "Represents the current state of the partition backup operation.", - "enum": [ - "Invalid", - "Accepted", - "BackupInProgress", - "Success", - "Failure", - "Timeout" - ], - "x-ms-enum": { - "name": "BackupState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Accepted", - "description": "Operation has been validated and accepted. Backup is yet to be triggered." - }, - { - "value": "BackupInProgress", - "description": "Backup operation has been triggered and is under process." - }, - { - "value": "Success", - "description": "Operation completed with success." - }, - { - "value": "Failure", - "description": "Operation completed with failure." - }, - { - "value": "Timeout", - "description": "Operation timed out." - } - ] - } - }, - "BackupEntity": { - "type": "object", - "discriminator": "EntityKind", - "description": "Describes the Service Fabric entity that is configured for backup.", - "properties": { - "EntityKind": { - "$ref": "#/definitions/BackupEntityKind", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." - } - }, - "required": [ - "EntityKind" - ] - }, - "ApplicationBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric application which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "ApplicationBackupEntity", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Application" - }, - "ServiceBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric stateful service which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "ServiceBackupEntity", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Service" - }, - "PartitionBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric stateful partition which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "PartitionBackupEntity", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - } - ], - "x-ms-discriminator-value": "Partition" - }, - "EnableBackupDescription": { - "description": "Specifies the parameters needed to enable periodic backup.", - "required": [ - "BackupPolicyName" - ], - "properties": { - "BackupPolicyName": { - "type": "string", - "description": "Name of the backup policy to be used for enabling periodic backups." - } - } - }, - "PagedBackupEntityList": { - "type": "object", - "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup entity information.", - "items": { - "$ref": "#/definitions/BackupEntity" - } - } - } - }, - "BackupSuspensionInfo": { - "type": "object", - "description": "Describes the backup suspension details.", - "properties": { - "IsSuspended": { - "type": "boolean", - "description": "Indicates whether periodic backup is suspended at this level or not." - }, - "SuspensionInheritedFrom": { - "$ref": "#/definitions/BackupSuspensionScope", - "description": "Specifies the scope at which the backup suspension was applied." - } - } - }, - "BackupEntityKind": { - "type": "string", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupEntityKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the entity is a Service Fabric partition." - }, - { - "value": "Service", - "description": "Indicates the entity is a Service Fabric service." - }, - { - "value": "Application", - "description": "Indicates the entity is a Service Fabric application." - } - ] - } - }, - "GetBackupByStorageQueryDescription": { - "type": "object", - "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.", - "required": [ - "Storage", - "BackupEntity" - ], - "properties": { - "StartDateTimeFilter": { - "type": "string", - "format": "date-time", - "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning." - }, - "EndDateTimeFilter": { - "type": "string", - "format": "date-time", - "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end." - }, - "Latest": { - "type": "boolean", - "default": false, - "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity." - }, - "Storage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore." - }, - "BackupEntity": { - "$ref": "#/definitions/BackupEntity", - "description": "Indicates the entity for which to enumerate backups." - } - } - }, - "NodeImpact": { - "type": "object", - "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "NodeName": { - "type": "string", - "description": "The name of the impacted node." - }, - "ImpactLevel": { - "type": "string", - "enum": [ - "Invalid", - "None", - "Restart", - "RemoveData", - "RemoveNode" - ], - "description": "The level of impact expected.", - "x-ms-enum": { - "name": "ImpactLevel", - "modelAsString": true, - "values": [ - { - "value": "Invalid" - }, - { - "value": "None" - }, - { - "value": "Restart" - }, - { - "value": "RemoveData" - }, - { - "value": "RemoveNode" - } - ] - } - } - }, - "required": [ - "NodeName" - ] - }, - "NodeRepairImpactDescription": { - "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "x-ms-discriminator-value": "Node", - "allOf": [ - { - "$ref": "#/definitions/RepairImpactDescriptionBase" - }, - { - "type": "object", - "description": "NodeRepairImpactDescription", - "properties": { - "NodeImpactList": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeImpact" - }, - "description": "The list of nodes impacted by a repair action and their respective expected impact." - } - } - } - ] - }, - "NodeRepairTargetDescription": { - "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "x-ms-discriminator-value": "Node", - "allOf": [ - { - "$ref": "#/definitions/RepairTargetDescriptionBase" - }, - { - "type": "object", - "description": "NodeRepairTargetDescription", - "properties": { - "NodeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of nodes targeted by a repair action." - } - } - } - ] - }, - "RepairImpactDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Kind": { - "$ref": "#/definitions/RepairImpactKind", - "description": "The kind of repair impact represented by the current object." - } - }, - "required": [ - "Kind" - ] - }, - "RepairImpactKind": { - "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", - "type": "string", - "enum": [ - "Invalid", - "Node" - ], - "x-ms-enum": { - "name": "RepairImpactKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The repair impact is not valid or is of an unknown type." - }, - { - "value": "Node", - "description": "The repair impact affects a set of Service Fabric nodes." - } - ] - } - }, - "RepairTargetDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Kind": { - "$ref": "#/definitions/RepairTargetKind", - "description": "The kind of repair target described by the current object." - } - }, - "required": [ - "Kind" - ] - }, - "RepairTargetKind": { - "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", - "type": "string", - "enum": [ - "Invalid", - "Node" - ], - "x-ms-enum": { - "name": "RepairTargetKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The repair target is not valid or is of an unknown type." - }, - { - "value": "Node", - "description": "The repair target is a set of Service Fabric nodes." - } - ] - } - }, - "RepairTask": { - "type": "object", - "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value." - }, - "Description": { - "type": "string", - "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set." - }, - "State": { - "type": "string", - "enum": [ - "Invalid", - "Created", - "Claimed", - "Preparing", - "Approved", - "Executing", - "Restoring", - "Completed" - ], - "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.", - "x-ms-enum": { - "name": "State", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value." - }, - { - "value": "Created", - "description": "Indicates that the repair task has been created." - }, - { - "value": "Claimed", - "description": "Indicates that the repair task has been claimed by a repair executor." - }, - { - "value": "Preparing", - "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully." - }, - { - "value": "Approved", - "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute." - }, - { - "value": "Executing", - "description": "Indicates that execution of the repair task is in progress." - }, - { - "value": "Restoring", - "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online." - }, - { - "value": "Completed", - "description": "Indicates that the repair task has completed, and no further state changes will occur." - } - ] - } - }, - "Flags": { - "type": "integer", - "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request" - }, - "Action": { - "type": "string", - "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set." - }, - "Target": { - "$ref": "#/definitions/RepairTargetDescriptionBase", - "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set." - }, - "Executor": { - "type": "string", - "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set." - }, - "ExecutorData": { - "type": "string", - "description": "A data string that the repair executor can use to store its internal state." - }, - "Impact": { - "$ref": "#/definitions/RepairImpactDescriptionBase", - "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set." - }, - "ResultStatus": { - "type": "string", - "enum": [ - "Invalid", - "Succeeded", - "Cancelled", - "Interrupted", - "Failed", - "Pending" - ], - "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.", - "x-ms-enum": { - "name": "ResultStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value." - }, - { - "value": "Succeeded", - "description": "Indicates that the repair task completed execution successfully." - }, - { - "value": "Cancelled", - "description": "Indicates that the repair task was cancelled prior to execution." - }, - { - "value": "Interrupted", - "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed." - }, - { - "value": "Failed", - "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed." - }, - { - "value": "Pending", - "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing." - } - ] - } - }, - "ResultCode": { - "type": "integer", - "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." - }, - "ResultDetails": { - "type": "string", - "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." - }, - "History": { - "$ref": "#/definitions/RepairTaskHistory", - "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified." - }, - "PreparingHealthCheckState": { - "$ref": "#/definitions/RepairTaskHealthCheckState", - "description": "The workflow state of the health check when the repair task is in the Preparing state." - }, - "RestoringHealthCheckState": { - "$ref": "#/definitions/RepairTaskHealthCheckState", - "description": "The workflow state of the health check when the repair task is in the Restoring state." - }, - "PerformPreparingHealthCheck": { - "type": "boolean", - "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state." - }, - "PerformRestoringHealthCheck": { - "type": "boolean", - "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state." - } - }, - "required": [ - "TaskId", - "Action", - "State" - ] - }, - "RepairTaskApproveDescription": { - "type": "object", - "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskCancelDescription": { - "type": "object", - "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - }, - "RequestAbort": { - "type": "boolean", - "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskDeleteDescription": { - "type": "object", - "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the completed repair task to be deleted." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskHealthCheckState": { - "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "type": "string", - "enum": [ - "NotStarted", - "InProgress", - "Succeeded", - "Skipped", - "TimedOut" - ], - "x-ms-enum": { - "name": "RepairTaskHealthCheckState", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "description": "Indicates that the health check has not started." - }, - { - "value": "InProgress", - "description": "Indicates that the health check is in progress." - }, - { - "value": "Succeeded", - "description": "Indicates that the health check succeeded." - }, - { - "value": "Skipped", - "description": "Indicates that the health check was skipped." - }, - { - "value": "TimedOut", - "description": "Indicates that the health check timed out." - } - ] - } - }, - "RepairTaskHistory": { - "type": "object", - "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "CreatedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Created state." - }, - "ClaimedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Claimed state." - }, - "PreparingUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Preparing state." - }, - "ApprovedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Approved state" - }, - "ExecutingUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Executing state" - }, - "RestoringUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Restoring state" - }, - "CompletedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Completed state" - }, - "PreparingHealthCheckStartUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task started the health check in the Preparing state." - }, - "PreparingHealthCheckEndUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task completed the health check in the Preparing state." - }, - "RestoringHealthCheckStartUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task started the health check in the Restoring state." - }, - "RestoringHealthCheckEndUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task completed the health check in the Restoring state." - } - } - }, - "RepairTaskList": { - "type": "array", - "description": "A list of repair tasks.", - "items": { - "$ref": "#/definitions/RepairTask" - } - }, - "RepairTaskUpdateHealthPolicyDescription": { - "type": "object", - "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task to be updated." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed." - }, - "PerformPreparingHealthCheck": { - "type": "boolean", - "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." - }, - "PerformRestoringHealthCheck": { - "type": "boolean", - "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskUpdateInfo": { - "type": "object", - "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Version": { - "type": "string", - "description": "The new version of the repair task." - } - }, - "required": [ - "Version" - ] - }, - "ReconfigurationInformation": { - "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.", - "properties": { - "PreviousConfigurationRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "Replica role before reconfiguration started." - }, - "ReconfigurationPhase": { - "$ref": "#/definitions/ReconfigurationPhase", - "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." - }, - "ReconfigurationType": { - "$ref": "#/definitions/ReconfigurationType", - "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." - }, - "ReconfigurationStartTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time." - } - } - }, - "ReconfigurationPhase": { - "type": "string", - "description": "The reconfiguration phase of a replica of a stateful service.", - "enum": [ - "Unknown", - "None", - "Phase0", - "Phase1", - "Phase2", - "Phase3", - "Phase4", - "AbortPhaseZero" - ], - "x-ms-enum": { - "name": "ReconfigurationPhase", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the invalid reconfiguration phase." - }, - { - "value": "None", - "description": "Specifies that there is no reconfiguration in progress." - }, - { - "value": "Phase0", - "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary." - }, - { - "value": "Phase1", - "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress." - }, - { - "value": "Phase2", - "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set." - }, - { - "value": "Phase3", - "description": "This phase is for internal use only." - }, - { - "value": "Phase4", - "description": "This phase is for internal use only." - }, - { - "value": "AbortPhaseZero", - "description": "This phase is for internal use only." - } - ] - } - }, - "ReconfigurationType": { - "type": "string", - "description": "The type of reconfiguration for replica of a stateful service.", - "enum": [ - "Unknown", - "SwapPrimary", - "Failover", - "Other" - ], - "x-ms-enum": { - "name": "ReconfigurationType", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the invalid reconfiguration type." - }, - { - "value": "SwapPrimary", - "description": "Specifies that the primary replica is being swapped with a different replica." - }, - { - "value": "Failover", - "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc." - }, - { - "value": "Other", - "description": "Reconfigurations where the primary replica is not changing." - } - ] - } - }, - "InfrastructureServiceResponse": { - "type": "string", - "format": "binary", - "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service." - }, - "UploadChunkRange": { - "type": "object", - "description": "Information about which portion of the file to upload.", - "properties": { - "StartPosition": { - "type": "string", - "description": "The start position of the portion of the file. It's represented by the number of bytes." - }, - "EndPosition": { - "type": "string", - "description": "The end position of the portion of the file. It's represented by the number of bytes." - } - } - }, - "UploadSessionInfo": { - "type": "object", - "description": "Information about an image store upload session. A session is associated with a relative path in the image store.", - "properties": { - "StoreRelativePath": { - "type": "string", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "SessionId": { - "type": "string", - "format": "uuid", - "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed." - }, - "ModifiedDate": { - "type": "string", - "format": "date-time", - "description": "The date and time when the upload session was last modified." - }, - "FileSize": { - "type": "string", - "description": "The size in bytes of the uploading file." - }, - "ExpectedRanges": { - "type": "array", - "items": { - "$ref": "#/definitions/UploadChunkRange" - }, - "description": "List of chunk ranges that image store has not received yet." - } - } - }, - "UploadSession": { - "type": "object", - "description": "Information about a image store upload session", - "properties": { - "UploadSessions": { - "type": "array", - "items": { - "$ref": "#/definitions/UploadSessionInfo" - }, - "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions." - } - } - }, - "ContainerLogs": { - "type": "object", - "description": "Container logs.", - "properties": { - "Content": { - "type": "string", - "description": "Container logs." - } - } - }, - "ScalingPolicyDescription": { - "type": "object", - "description": "Describes how the scaling should be performed", - "required": [ - "ScalingTrigger", - "ScalingMechanism" - ], - "properties": { - "ScalingTrigger": { - "$ref": "#/definitions/ScalingTriggerDescription", - "description": "Specifies the trigger associated with this scaling policy" - }, - "ScalingMechanism": { - "$ref": "#/definitions/ScalingMechanismDescription", - "description": "Specifies the mechanism associated with this scaling policy" - } - } - }, - "ScalingPolicyDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ScalingPolicyDescription" - }, - "description": "A list that describes the scaling policies." - }, - "ScalingTriggerDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the trigger for performing a scaling operation.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ScalingTriggerKind", - "description": "Specifies the kind of scaling trigger" - } - } - }, - "ScalingMechanismDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the mechanism for performing a scaling operation.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ScalingMechanismKind", - "description": "Specifies the kind of scaling mechanism" - } - } - }, - "ScalingTriggerKind": { - "type": "string", - "description": "Enumerates the ways that a service can be scaled.", - "enum": [ - "Invalid", - "AveragePartitionLoad", - "AverageServiceLoad" - ], - "x-ms-enum": { - "name": "ScalingTriggerKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "AveragePartitionLoad", - "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1." - }, - { - "value": "AverageServiceLoad", - "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2." - } - ] - } - }, - "ScalingMechanismKind": { - "type": "string", - "description": "Enumerates the ways that a service can be scaled.", - "enum": [ - "Invalid", - "PartitionInstanceCount", - "AddRemoveIncrementalNamedPartition" - ], - "x-ms-enum": { - "name": "ScalingMechanismKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "PartitionInstanceCount", - "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1." - }, - { - "value": "AddRemoveIncrementalNamedPartition", - "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2." - } - ] - } - }, - "AveragePartitionLoadScalingTrigger": { - "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", - "allOf": [ - { - "$ref": "#/definitions/ScalingTriggerDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AveragePartitionLoad", - "required": [ - "MetricName", - "LowerLoadThreshold", - "UpperLoadThreshold", - "ScaleIntervalInSeconds" - ], - "properties": { - "MetricName": { - "type": "string", - "description": "The name of the metric for which usage should be tracked." - }, - "LowerLoadThreshold": { - "type": "string", - "format": "double", - "description": "The lower limit of the load below which a scale in operation should be performed." - }, - "UpperLoadThreshold": { - "type": "string", - "format": "double", - "description": "The upper limit of the load beyond which a scale out operation should be performed." - }, - "ScaleIntervalInSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The period in seconds on which a decision is made whether to scale or not." - } - } - }, - "AverageServiceLoadScalingTrigger": { - "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", - "allOf": [ - { - "$ref": "#/definitions/ScalingTriggerDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AverageServiceLoad", - "required": [ - "MetricName", - "LowerLoadThreshold", - "UpperLoadThreshold", - "ScaleIntervalInSeconds" - ], - "properties": { - "MetricName": { - "type": "string", - "description": "The name of the metric for which usage should be tracked." - }, - "LowerLoadThreshold": { - "type": "string", - "format": "double", - "description": "The lower limit of the load below which a scale in operation should be performed." - }, - "UpperLoadThreshold": { - "type": "string", - "format": "double", - "description": "The upper limit of the load beyond which a scale out operation should be performed." - }, - "ScaleIntervalInSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The period in seconds on which a decision is made whether to scale or not." - } - } - }, - "PartitionInstanceCountScaleMechanism": { - "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", - "allOf": [ - { - "$ref": "#/definitions/ScalingMechanismDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "PartitionInstanceCount", - "required": [ - "MinInstanceCount", - "MaxInstanceCount", - "ScaleIncrement" - ], - "properties": { - "MinInstanceCount": { - "type": "integer", - "description": "Minimum number of instances of the partition." - }, - "MaxInstanceCount": { - "type": "integer", - "description": "Maximum number of instances of the partition." - }, - "ScaleIncrement": { - "type": "integer", - "description": "The number of instances to add or remove during a scaling operation." - } - } - }, - "AddRemoveIncrementalNamedPartitionScalingMechanism": { - "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'", - "allOf": [ - { - "$ref": "#/definitions/ScalingMechanismDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", - "required": [ - "MinPartitionCount", - "MaxPartitionCount", - "ScaleIncrement" - ], - "properties": { - "MinPartitionCount": { - "type": "integer", - "description": "Minimum number of named partitions of the service." - }, - "MaxPartitionCount": { - "type": "integer", - "description": "Maximum number of named partitions of the service." - }, - "ScaleIncrement": { - "type": "integer", - "description": "The number of instances to add or remove during a scaling operation." - } - } - }, - "ApplicationCreatedEvent": { - "description": "Application Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "ApplicationDefinitionKind": { - "type": "string", - "description": "Application definition kind." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "ApplicationDefinitionKind" - ] - } - ], - "x-ms-discriminator-value": "ApplicationCreated" - }, - "ApplicationDeletedEvent": { - "description": "Application Deleted event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion" - ] - } - ], - "x-ms-discriminator-value": "ApplicationDeleted" - }, - "ApplicationHealthReportCreatedEvent": { - "description": "Application Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ApplicationHealthReportCreated" - }, - "ApplicationHealthReportExpiredEvent": { - "description": "Application Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ApplicationHealthReportExpired" - }, - "ApplicationUpgradeCompleteEvent": { - "description": "Application Upgrade Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeComplete" - }, - "ApplicationUpgradeDomainCompleteEvent": { - "description": "Application Upgrade Domain Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "UpgradeState": { - "type": "string", - "description": "State of upgrade." - }, - "UpgradeDomains": { - "type": "string", - "description": "Upgrade domains." - }, - "UpgradeDomainElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Upgrade time of domain in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "UpgradeState", - "UpgradeDomains", - "UpgradeDomainElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeDomainComplete" - }, - "ApplicationUpgradeRollbackCompleteEvent": { - "description": "Application Upgrade Rollback Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "FailureReason": { - "type": "string", - "description": "Describes reason of failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeRollbackComplete" - }, - "ApplicationUpgradeRollbackStartEvent": { - "description": "Application Upgrade Rollback Start event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "FailureReason": { - "type": "string", - "description": "Describes reason of failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeRollbackStart" - }, - "ApplicationUpgradeStartEvent": { - "description": "Application Upgrade Start event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "UpgradeType": { - "type": "string", - "description": "Type of upgrade." - }, - "RollingUpgradeMode": { - "type": "string", - "description": "Mode of upgrade." - }, - "FailureAction": { - "type": "string", - "description": "Action if failed." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "UpgradeType", - "RollingUpgradeMode", - "FailureAction" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeStart" - }, - "DeployedApplicationHealthReportCreatedEvent": { - "description": "Deployed Application Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedApplicationHealthReportCreated" - }, - "DeployedApplicationHealthReportExpiredEvent": { - "description": "Deployed Application Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired" - }, - "ProcessDeactivatedEvent": { - "description": "Process Deactivated event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceName": { - "type": "string", - "description": "Name of Service." - }, - "ServicePackageName": { - "type": "string", - "description": "Name of Service package." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Activation Id of Service package." - }, - "IsExclusive": { - "type": "boolean", - "description": "Indicates IsExclusive flag." - }, - "CodePackageName": { - "type": "string", - "description": "Name of Code package." - }, - "EntryPointType": { - "type": "string", - "description": "Type of EntryPoint." - }, - "ExeName": { - "type": "string", - "description": "Name of executable." - }, - "ProcessId": { - "type": "integer", - "format": "int64", - "description": "Process Id." - }, - "HostId": { - "type": "string", - "description": "Host Id." - }, - "ExitCode": { - "type": "integer", - "format": "int64", - "description": "Exit code of process." - }, - "UnexpectedTermination": { - "type": "boolean", - "description": "Indicates if termination is unexpected." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time of process." - } - }, - "required": [ - "ServiceName", - "ServicePackageName", - "ServicePackageActivationId", - "IsExclusive", - "CodePackageName", - "EntryPointType", - "ExeName", - "ProcessId", - "HostId", - "ExitCode", - "UnexpectedTermination", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "ProcessDeactivated" - }, - "ContainerDeactivatedEvent": { - "description": "Container Deactivated event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceName": { - "type": "string", - "description": "Name of Service." - }, - "ServicePackageName": { - "type": "string", - "description": "Name of Service package." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Activation Id of Service package." - }, - "IsExclusive": { - "type": "boolean", - "description": "Indicates IsExclusive flag." - }, - "CodePackageName": { - "type": "string", - "description": "Name of Code package." - }, - "EntryPointType": { - "type": "string", - "description": "Type of EntryPoint." - }, - "ImageName": { - "type": "string", - "description": "Name of Container image." - }, - "ContainerName": { - "type": "string", - "description": "Name of Container." - }, - "HostId": { - "type": "string", - "description": "Host Id." - }, - "ExitCode": { - "type": "integer", - "format": "int64", - "description": "Exit code of process." - }, - "UnexpectedTermination": { - "type": "boolean", - "description": "Indicates if termination is unexpected." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time of process." - } - }, - "required": [ - "ServiceName", - "ServicePackageName", - "ServicePackageActivationId", - "IsExclusive", - "CodePackageName", - "EntryPointType", - "ImageName", - "ContainerName", - "HostId", - "ExitCode", - "UnexpectedTermination", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "ContainerDeactivated" - }, - "NodeAbortedEvent": { - "description": "Node Aborted event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeAborted" - }, - "NodeAbortingEvent": { - "description": "Node Aborting event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeAborting" - }, - "NodeAddedEvent": { - "description": "Node Added event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeType": { - "type": "string", - "description": "Type of Node." - }, - "FabricVersion": { - "type": "string", - "description": "Fabric version." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "NodeCapacities": { - "type": "string", - "description": "Capacities." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "NodeType", - "FabricVersion", - "IpAddressOrFQDN", - "NodeCapacities" - ] - } - ], - "x-ms-discriminator-value": "NodeAdded" - }, - "NodeCloseEvent": { - "description": "Node Close event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "string", - "description": "Id of Node instance." - }, - "Error": { - "type": "string", - "description": "Describes error." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "Error" - ] - } - ], - "x-ms-discriminator-value": "NodeClose" - }, - "NodeClosingEvent": { - "description": "Node Closing event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeClosing" - }, - "NodeDeactivateCompleteEvent": { - "description": "Node Deactivate Complete event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "EffectiveDeactivateIntent": { - "type": "string", - "description": "Describes deactivate intent." - }, - "BatchIdsWithDeactivateIntent": { - "type": "string", - "description": "Batch Ids." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time." - } - }, - "required": [ - "NodeInstance", - "EffectiveDeactivateIntent", - "BatchIdsWithDeactivateIntent", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "NodeDeactivateComplete" - }, - "NodeDeactivateStartEvent": { - "description": "Node Deactivate Start event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "BatchId": { - "type": "string", - "description": "Batch Id." - }, - "DeactivateIntent": { - "type": "string", - "description": "Describes deactivate intent." - } - }, - "required": [ - "NodeInstance", - "BatchId", - "DeactivateIntent" - ] - } - ], - "x-ms-discriminator-value": "NodeDeactivateStart" - }, - "NodeDownEvent": { - "description": "Node Down event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "LastNodeUpAt": { - "type": "string", - "format": "date-time", - "description": "Time when Node was last up." - } - }, - "required": [ - "NodeInstance", - "LastNodeUpAt" - ] - } - ], - "x-ms-discriminator-value": "NodeDown" - }, - "NodeHealthReportCreatedEvent": { - "description": "Node Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "NodeInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "NodeHealthReportCreated" - }, - "NodeHealthReportExpiredEvent": { - "description": "Node Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "NodeInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "NodeHealthReportExpired" - }, - "NodeOpenedSuccessEvent": { - "description": "Node Opened Success event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeOpenedSuccess" - }, - "NodeOpenFailedEvent": { - "description": "Node Open Failed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - }, - "Error": { - "type": "string", - "description": "Describes the error." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion", - "Error" - ] - } - ], - "x-ms-discriminator-value": "NodeOpenFailed" - }, - "NodeOpeningEvent": { - "description": "Node Opening event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeOpening" - }, - "NodeRemovedEvent": { - "description": "Node Removed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeType": { - "type": "string", - "description": "Type of Node." - }, - "FabricVersion": { - "type": "string", - "description": "Fabric version." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "NodeCapacities": { - "type": "string", - "description": "Capacities." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "NodeType", - "FabricVersion", - "IpAddressOrFQDN", - "NodeCapacities" - ] - } - ], - "x-ms-discriminator-value": "NodeRemoved" - }, - "NodeUpEvent": { - "description": "Node Up event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "LastNodeDownAt": { - "type": "string", - "format": "date-time", - "description": "Time when Node was last down." - } - }, - "required": [ - "NodeInstance", - "LastNodeDownAt" - ] - } - ], - "x-ms-discriminator-value": "NodeUp" - }, - "PartitionHealthReportCreatedEvent": { - "description": "Partition Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "PartitionHealthReportCreated" - }, - "PartitionHealthReportExpiredEvent": { - "description": "Partition Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "PartitionHealthReportExpired" - }, - "PartitionReconfigurationCompletedEvent": { - "description": "Partition Reconfiguration Completed event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "NodeInstanceId": { - "type": "string", - "description": "Id of Node instance." - }, - "ServiceType": { - "type": "string", - "description": "Type of Service." - }, - "CcEpochDataLossVersion": { - "type": "integer", - "format": "int64", - "description": "CcEpochDataLoss version." - }, - "CcEpochConfigVersion": { - "type": "integer", - "format": "int64", - "description": "CcEpochConfig version." - }, - "ReconfigType": { - "type": "string", - "description": "Type of reconfiguration." - }, - "Result": { - "type": "string", - "description": "Describes reconfiguration result." - }, - "Phase0DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase0 in milli-seconds." - }, - "Phase1DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase1 in milli-seconds." - }, - "Phase2DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase2 in milli-seconds." - }, - "Phase3DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase3 in milli-seconds." - }, - "Phase4DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase4 in milli-seconds." - }, - "TotalDurationMs": { - "type": "number", - "format": "double", - "description": "Total duration in milli-seconds." - } - }, - "required": [ - "NodeName", - "NodeInstanceId", - "ServiceType", - "CcEpochDataLossVersion", - "CcEpochConfigVersion", - "ReconfigType", - "Result", - "Phase0DurationMs", - "Phase1DurationMs", - "Phase2DurationMs", - "Phase3DurationMs", - "Phase4DurationMs", - "TotalDurationMs" - ] - } - ], - "x-ms-discriminator-value": "PartitionReconfigurationCompleted" - }, - "PartitionPrimaryMoveAnalysisEvent": { - "description": "Partition Primary Move Analysis event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionAnalysisEvent" - }, - { - "type": "object", - "properties": { - "WhenMoveCompleted": { - "type": "string", - "format": "date-time", - "description": "Time when the move was completed." - }, - "PreviousNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "CurrentNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "MoveReason": { - "type": "string", - "description": "Move reason." - }, - "RelevantTraces": { - "type": "string", - "description": "Relevant traces." - } - }, - "required": [ - "WhenMoveCompleted", - "PreviousNode", - "CurrentNode", - "MoveReason", - "RelevantTraces" - ] - } - ], - "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis" - }, - "ServiceCreatedEvent": { - "description": "Service Created event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Service type name." - }, - "ApplicationName": { - "type": "string", - "description": "Application name." - }, - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ServiceInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates if Service is stateful." - }, - "PartitionCount": { - "type": "integer", - "format": "int32", - "description": "Number of partitions." - }, - "TargetReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Size of target replicas set." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Minimum size of replicas set." - }, - "ServicePackageVersion": { - "type": "string", - "description": "Version of Service package." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - }, - "required": [ - "ServiceTypeName", - "ApplicationName", - "ApplicationTypeName", - "ServiceInstance", - "IsStateful", - "PartitionCount", - "TargetReplicaSetSize", - "MinReplicaSetSize", - "ServicePackageVersion", - "PartitionId" - ] - } - ], - "x-ms-discriminator-value": "ServiceCreated" - }, - "ServiceDeletedEvent": { - "description": "Service Deleted event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Service type name." - }, - "ApplicationName": { - "type": "string", - "description": "Application name." - }, - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ServiceInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates if Service is stateful." - }, - "PartitionCount": { - "type": "integer", - "format": "int32", - "description": "Number of partitions." - }, - "TargetReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Size of target replicas set." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Minimum size of replicas set." - }, - "ServicePackageVersion": { - "type": "string", - "description": "Version of Service package." - } - }, - "required": [ - "ServiceTypeName", - "ApplicationName", - "ApplicationTypeName", - "ServiceInstance", - "IsStateful", - "PartitionCount", - "TargetReplicaSetSize", - "MinReplicaSetSize", - "ServicePackageVersion" - ] - } - ], - "x-ms-discriminator-value": "ServiceDeleted" - }, - "ServiceHealthReportCreatedEvent": { - "description": "Service Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "InstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "InstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ServiceHealthReportCreated" - }, - "ServiceHealthReportExpiredEvent": { - "description": "Service Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "InstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "InstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ServiceHealthReportExpired" - }, - "DeployedServiceHealthReportCreatedEvent": { - "description": "Deployed Service Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "ServicePackageInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service package instance." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TTLTimespan": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ServiceManifestName", - "ServicePackageInstanceId", - "ServicePackageActivationId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TTLTimespan", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedServiceHealthReportCreated" - }, - "DeployedServiceHealthReportExpiredEvent": { - "description": "Deployed Service Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceManifest": { - "type": "string", - "description": "Service manifest name." - }, - "ServicePackageInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service package instance." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TTLTimespan": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ServiceManifest", - "ServicePackageInstanceId", - "ServicePackageActivationId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TTLTimespan", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedServiceHealthReportExpired" - }, - "StatefulReplicaHealthReportCreatedEvent": { - "description": "Stateful Replica Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "ReplicaInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Replica instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ReplicaInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatefulReplicaHealthReportCreated" - }, - "StatefulReplicaHealthReportExpiredEvent": { - "description": "Stateful Replica Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "ReplicaInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Replica instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ReplicaInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired" - }, - "StatelessReplicaHealthReportCreatedEvent": { - "description": "Stateless Replica Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatelessReplicaHealthReportCreated" - }, - "StatelessReplicaHealthReportExpiredEvent": { - "description": "Stateless Replica Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired" - }, - "ClusterHealthReportCreatedEvent": { - "description": "Cluster Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ClusterHealthReportCreated" - }, - "ClusterHealthReportExpiredEvent": { - "description": "Cluster Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ClusterHealthReportExpired" - }, - "ClusterUpgradeCompleteEvent": { - "description": "Cluster Upgrade Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeComplete" - }, - "ClusterUpgradeDomainCompleteEvent": { - "description": "Cluster Upgrade Domain Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "UpgradeState": { - "type": "string", - "description": "State of upgrade." - }, - "UpgradeDomains": { - "type": "string", - "description": "Upgrade domains." - }, - "UpgradeDomainElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Duration of domain upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "UpgradeState", - "UpgradeDomains", - "UpgradeDomainElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeDomainComplete" - }, - "ClusterUpgradeRollbackCompleteEvent": { - "description": "Cluster Upgrade Rollback Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "FailureReason": { - "type": "string", - "description": "Describes failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeRollbackComplete" - }, - "ClusterUpgradeRollbackStartEvent": { - "description": "Cluster Upgrade Rollback Start event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "FailureReason": { - "type": "string", - "description": "Describes failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeRollbackStart" - }, - "ClusterUpgradeStartEvent": { - "description": "Cluster Upgrade Start event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "CurrentClusterVersion": { - "type": "string", - "description": "Current Cluster version." - }, - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "UpgradeType": { - "type": "string", - "description": "Type of upgrade." - }, - "RollingUpgradeMode": { - "type": "string", - "description": "Mode of upgrade." - }, - "FailureAction": { - "type": "string", - "description": "Action if failed." - } - }, - "required": [ - "CurrentClusterVersion", - "TargetClusterVersion", - "UpgradeType", - "RollingUpgradeMode", - "FailureAction" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeStart" - }, - "ChaosStoppedEvent": { - "description": "Chaos Stopped event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "Reason": { - "type": "string", - "description": "Describes reason." - } - }, - "required": [ - "Reason" - ] - } - ], - "x-ms-discriminator-value": "ChaosStopped" - }, - "ChaosStartedEvent": { - "description": "Chaos Started event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "MaxConcurrentFaults": { - "type": "integer", - "format": "int64", - "description": "Maximum number of concurrent faults." - }, - "TimeToRunInSeconds": { - "type": "number", - "format": "double", - "description": "Time to run in seconds." - }, - "MaxClusterStabilizationTimeoutInSeconds": { - "type": "number", - "format": "double", - "description": "Maximum timeout for cluster stabilization in seconds." - }, - "WaitTimeBetweenIterationsInSeconds": { - "type": "number", - "format": "double", - "description": "Wait time between iterations in seconds." - }, - "WaitTimeBetweenFautlsInSeconds": { - "type": "number", - "format": "double", - "description": "Wait time between faults in seconds." - }, - "MoveReplicaFaultEnabled": { - "type": "boolean", - "description": "Indicates MoveReplica fault is enabled." - }, - "IncludedNodeTypeList": { - "type": "string", - "description": "List of included Node types." - }, - "IncludedApplicationList": { - "type": "string", - "description": "List of included Applications." - }, - "ClusterHealthPolicy": { - "type": "string", - "description": "Health policy." - }, - "ChaosContext": { - "type": "string", - "description": "Chaos Context." - } - }, - "required": [ - "MaxConcurrentFaults", - "TimeToRunInSeconds", - "MaxClusterStabilizationTimeoutInSeconds", - "WaitTimeBetweenIterationsInSeconds", - "WaitTimeBetweenFautlsInSeconds", - "MoveReplicaFaultEnabled", - "IncludedNodeTypeList", - "IncludedApplicationList", - "ClusterHealthPolicy", - "ChaosContext" - ] - } - ], - "x-ms-discriminator-value": "ChaosStarted" - }, - "ChaosRestartNodeFaultCompletedEvent": { - "description": "Chaos Restart Node Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - } - }, - "required": [ - "NodeInstanceId", - "FaultGroupId", - "FaultId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartNodeFaultCompleted" - }, - "ChaosRestartCodePackageFaultScheduledEvent": { - "description": "Chaos Restart Code Package Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "CodePackageName": { - "type": "string", - "description": "Code package name." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "NodeName", - "ServiceManifestName", - "CodePackageName", - "ServicePackageActivationId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartCodePackageFaultScheduled" - }, - "ChaosRestartCodePackageFaultCompletedEvent": { - "description": "Chaos Restart Code Package Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "CodePackageName": { - "type": "string", - "description": "Code package name." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "NodeName", - "ServiceManifestName", - "CodePackageName", - "ServicePackageActivationId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartCodePackageFaultCompleted" - }, - "ChaosRemoveReplicaFaultScheduledEvent": { - "description": "Chaos Remove Replica Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRemoveReplicaFaultScheduled" - }, - "ChaosRemoveReplicaFaultCompletedEvent": { - "description": "Chaos Remove Replica Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRemoveReplicaFaultCompleted" - }, - "ChaosMoveSecondaryFaultScheduledEvent": { - "description": "Chaos Move Secondary Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceName": { - "type": "string", - "description": "Service name." - }, - "SourceNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "DestinationNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ForcedMove": { - "type": "boolean", - "description": "Indicates a forced move." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceName", - "SourceNode", - "DestinationNode", - "ForcedMove" - ] - } - ], - "x-ms-discriminator-value": "ChaosMoveSecondaryFaultScheduled" - }, - "ChaosMovePrimaryFaultScheduledEvent": { - "description": "Chaos Move Primary Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceName": { - "type": "string", - "description": "Service name." - }, - "NodeTo": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ForcedMove": { - "type": "boolean", - "description": "Indicates a forced move." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceName", - "NodeTo", - "ForcedMove" - ] - } - ], - "x-ms-discriminator-value": "ChaosMovePrimaryFaultScheduled" - }, - "ChaosRestartReplicaFaultScheduledEvent": { - "description": "Chaos Restart Replica Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartReplicaFaultScheduled" - }, - "ChaosRestartNodeFaultScheduledEvent": { - "description": "Chaos Restart Node Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - } - }, - "required": [ - "NodeInstanceId", - "FaultGroupId", - "FaultId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartNodeFaultScheduled" - } - }, - "parameters": { - "ApiVersion_6-0-Preview_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.0-preview" - ], - "required": true, - "default": "6.0-preview", - "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.", - "x-ms-enum": { - "name": "ApiVersion_6-0-Preview_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.0-preview", - "description": "The version number for the preview functionality of 6.0 runtime." - } - ] - } - }, - "ApiVersion_6-0_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.0" - ], - "required": true, - "default": "6.0", - "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-0_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.0", - "description": "The 6.0 version of the API." - } - ] - } - }, - "ApiVersion_6-1_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.1" - ], - "required": true, - "default": "6.1", - "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-1_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.1", - "description": "The 6.1 version of the API." - } - ] - } - }, - "ApiVersion_6-2_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.2" - ], - "required": true, - "default": "6.2", - "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-2_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.2", - "description": "The 6.2 version of the API." - } - ] - } - }, - "ApiVersion_6-2-Preview_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.2-preview" - ], - "required": true, - "default": "6.2-preview", - "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.", - "x-ms-enum": { - "name": "ApiVersion_6-2-Preview_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.2-preview", - "description": "The version number for the preview functionality of 6.2 runtime" - } - ] - } - }, - "ApplicationDefinitionKindFilterOptionalQueryParam": { - "name": "ApplicationDefinitionKindFilter", - "description": "Used to filter on ApplicationDefinitionKind which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationHealthPolicyOptionalBodyParam": { - "name": "ApplicationHealthPolicy", - "in": "body", - "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - }, - "ApplicationIdRequiredPathParam": { - "name": "applicationId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "ApplicationsHealthStateFilterOptionalQueryParam": { - "name": "ApplicationsHealthStateFilter", - "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationTypeDefinitionKindFilterOptionalQueryParam": { - "name": "ApplicationTypeDefinitionKindFilter", - "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationTypeNameOptionalQueryParam": { - "name": "ApplicationTypeName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The application type name used to filter the applications to query for. This value should not contain the application type version." - }, - "ApplicationTypeNameRequiredPathParam": { - "name": "applicationTypeName", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of the application type." - }, - "ApplicationTypeVersionOptionalQueryParam": { - "name": "ApplicationTypeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The version of the application type." - }, - "ApplicationTypeVersionRequiredQueryParam": { - "name": "ApplicationTypeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The version of the application type." - }, - "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": { - "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam", - "in": "body", - "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - } - }, - "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": { - "name": "ClusterConfigurationUpgradeDescription", - "in": "body", - "description": "Parameters for a standalone cluster configuration upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterConfigurationUpgradeDescription" - } - }, - "ClusterHealthPoliciesOptionalBodyParam": { - "name": "ClusterHealthPolicies", - "in": "body", - "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthPolicies" - } - }, - "ClusterHealthPolicyOptionalBodyParam": { - "name": "ClusterHealthPolicy", - "in": "body", - "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthPolicy" - } - }, - "ClusterHealthChunkQueryDescriptionOptionalBodyParam": { - "name": "ClusterHealthChunkQueryDescription", - "in": "body", - "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthChunkQueryDescription" - } - }, - "CodePackageInstanceIdRequiredQueryParam": { - "name": "CodePackageInstanceId", - "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "CodeVersionOptionalQueryParam": { - "name": "CodeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The product version of Service Fabric." - }, - "ConfigVersionOptionalQueryParam": { - "name": "ConfigVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The config version of Service Fabric." - }, - "ConfigurationApiVersionRequiredQueryParam": { - "name": "ConfigurationApiVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The API version of the Standalone cluster json configuration." - }, - "ContainerApiRequiredBodyParam": { - "name": "ContainerApiRequestBody", - "in": "body", - "description": "Parameters for making container API call", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ContainerApiRequestBody" - } - }, - "ContinuationTokenOptionalQueryParam": { - "name": "ContinuationToken", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token does not contain a value. The value of this parameter should not be URL encoded." - }, - "DeployedApplicationsHealthStateFilterOptionalQueryParam": { - "name": "DeployedApplicationsHealthStateFilter", - "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeployedServicePackagesHealthStateFilterOptionalQueryParam": { - "name": "DeployedServicePackagesHealthStateFilter", - "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag based enumeration, so the value can be a combination of these value obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeploymentNameRequiredPathParam": { - "name": "deploymentName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the deployment." - }, - "EventsHealthStateFilterOptionalQueryParam": { - "name": "EventsHealthStateFilter", - "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ExcludeApplicationParametersOptionalQueryParam": { - "name": "ExcludeApplicationParameters", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "The flag that specifies whether application parameters will be excluded from the result." - }, - "HealthInformationRequiredBodyParam": { - "name": "HealthInformation", - "in": "body", - "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/HealthInformation" - } - }, - "NodeNameRequiredPathParam": { - "name": "nodeName", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of the node." - }, - "NodesHealthStateFilterOptionalQueryParam": { - "name": "NodesHealthStateFilter", - "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "NodeStatusFilterOptionalQueryParam": { - "name": "NodeStatusFilter", - "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "default", - "all", - "up", - "down", - "enabling", - "disabling", - "disabled", - "unknown", - "removed" - ], - "required": false, - "default": "default", - "x-ms-enum": { - "name": "NodeStatusFilter", - "modelAsString": true, - "values": [ - { - "value": "default", - "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." - }, - { - "value": "all", - "description": "This filter value will match all of the nodes." - }, - { - "value": "up", - "description": "This filter value will match nodes that are Up." - }, - { - "value": "down", - "description": "This filter value will match nodes that are Down." - }, - { - "value": "enabling", - "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling." - }, - { - "value": "disabling", - "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling." - }, - { - "value": "disabled", - "description": "This filter value will match nodes that are Disabled." - }, - { - "value": "unknown", - "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime." - }, - { - "value": "removed", - "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API." - } - ] - } - }, - "PartitionIdOptionalQueryParam": { - "name": "PartitionId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": false, - "description": "The identity of the partition." - }, - "PartitionIdRequiredPathParam": { - "name": "partitionId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "format": "uuid", - "required": true, - "description": "The identity of the partition." - }, - "ProvisionFabricDescriptionRequiredBodyParam": { - "name": "ProvisionFabricDescription", - "in": "body", - "description": "Describes the parameters for provisioning a cluster.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ProvisionFabricDescription" - } - }, - "UnprovisionFabricDescriptionRequiredBodyParam": { - "name": "UnprovisionFabricDescription", - "in": "body", - "description": "Describes the parameters for unprovisioning a cluster.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UnprovisionFabricDescription" - } - }, - "ResumeClusterUpgradeDescriptionRequiredBodyParam": { - "name": "ResumeClusterUpgradeDescription", - "in": "body", - "description": "Describes the parameters for resuming a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ResumeClusterUpgradeDescription" - } - }, - "UpdateClusterUpgradeDescriptionRequiredBodyParam": { - "name": "UpdateClusterUpgradeDescription", - "in": "body", - "description": "Parameters for updating a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UpdateClusterUpgradeDescription" - } - }, - "StartClusterUpgradeDescriptionRequiredBodyParam": { - "name": "StartClusterUpgradeDescription", - "in": "body", - "description": "Describes the parameters for starting a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/StartClusterUpgradeDescription" - } - }, - "ReplicaHealthReportServiceKindRequiredQueryParam": { - "name": "ReplicaHealthReportServiceKind", - "in": "query", - "required": true, - "x-ms-parameter-location": "method", - "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.", - "type": "string", - "enum": [ - "Stateless", - "Stateful" - ], - "default": "Stateful", - "x-ms-enum": { - "name": "ReplicaHealthReportServiceKind", - "modelAsString": true, - "values": [ - { - "value": "Stateless", - "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1" - }, - { - "value": "Stateful", - "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." - } - ] - } - }, - "ReplicaIdRequiredPathParam": { - "name": "replicaId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identifier of the replica." - }, - "ReplicasHealthStateFilerOptionalQueryParam": { - "name": "ReplicasHealthStateFilter", - "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ServiceIdRequiredPathParam": { - "name": "serviceId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the service. This is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceManifestNameOptionalQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." - }, - "ServiceManifestNameRequiredQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." - }, - "ServicePackageNameRequiredPathParam": { - "name": "servicePackageName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The name of the service package." - }, - "ServicesHealthStateFilterOptionalQueryParam": { - "name": "ServicesHealthStateFilter", - "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "CreateServiceFromTemplateRequiredBodyParam": { - "name": "ServiceFromTemplateDescription", - "in": "body", - "description": "Describes the service that needs to be created from the template defined in the application manifest.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceFromTemplateDescription" - } - }, - "ServiceTypeNameOptionalQueryParam": { - "name": "ServiceTypeName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The service type name used to filter the services to query for." - }, - "InfrastructureCommandRequiredQueryParam": { - "name": "Command", - "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "InfrastructureServiceIdOptionalQueryParam": { - "name": "ServiceId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that have more than one instance of infrastructure service running.", - "required": false - }, - "ForceRemoveOptionalQueryParam": { - "name": "ForceRemove", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." - }, - "ForceRemoveReplicaOptionalQueryParam": { - "name": "ForceRemove", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." - }, - "DeactivationIntentDescriptionRequiredBodyParam": { - "name": "DeactivationIntentDescription", - "in": "body", - "description": "Describes the intent or reason for deactivating the node.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/DeactivationIntentDescription" - } - }, - "RestartNodeDescriptionRequiredBodyParam": { - "name": "RestartNodeDescription", - "in": "body", - "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestartNodeDescription" - } - }, - "ApplicationUpgradeDescriptionRequiredBodyParam": { - "name": "ApplicationUpgradeDescription", - "in": "body", - "description": "Parameters for an application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeDescription" - } - }, - "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": { - "name": "ComposeDeploymentUpgradeDescription", - "in": "body", - "description": "Parameters for upgrading compose deployment.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ComposeDeploymentUpgradeDescription" - } - }, - "ApplicationTypeImageStorePathRequiredBodyParam": { - "name": "ApplicationTypeImageStorePath", - "in": "body", - "description": "The relative path for the application package in the image store specified during the prior copy operation.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationTypeImageStorePath" - } - }, - "UnprovisionApplicationTypeRequiredBodyParam": { - "name": "UnprovisionApplicationTypeDescriptionInfo", - "in": "body", - "description": "The relative path for the application package in the image store specified during the prior copy operation.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo" - } - }, - "UpgradeOrchestrationServiceStateRequiredBodyParam": { - "name": "UpgradeOrchestrationServiceState", - "in": "body", - "x-ms-parameter-location": "method", - "required": true, - "description": "Service state of Service Fabric Upgrade Orchestration Service.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceState" - } - }, - "ChaosParametersRequiredBodyParam": { - "name": "ChaosParameters", - "in": "body", - "description": "Describes all the parameters to configure a Chaos run.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ChaosParameters" - } - }, - "StartTimeUtcOptionalQueryParam": { - "name": "StartTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." - }, - "EndTimeUtcOptionalQueryParam": { - "name": "EndTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." - }, - "ApplicationNameRequiredQueryParam": { - "name": "ApplicationName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme." - }, - "CreateComposeDeploymentRequiredBodyParam": { - "name": "CreateComposeDeploymentDescription", - "in": "body", - "description": "Describes the compose deployment that needs to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/CreateComposeDeploymentDescription" - } - }, - "PasswordEncryptedOptionalQueryParam": { - "name": "PasswordEncrypted", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Indicates that supplied container repository password is encrypted." - }, - "RepositoryPasswordOptionalQueryParam": { - "name": "RepositoryPassword", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The password for supplied username to connect to container repository." - }, - "RepositoryUserNameOptionalQueryParam": { - "name": "RepositoryUserName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The user name to connect to container repository." - }, - "MaxResultsOptionalQueryParam": { - "name": "MaxResults", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int64", - "minimum": 0, - "default": 0, - "required": false, - "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged queries includes as many results as possible that fit in the return message." - }, - "ApplicationDescriptionRequiredBodyParam": { - "name": "ApplicationDescription", - "in": "body", - "description": "Description for creating an application.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationDescription" - } - }, - "ServiceDescriptionRequiredBodyParam": { - "name": "ServiceDescription", - "in": "body", - "description": "The information necessary to create a service.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - }, - "ServiceUpdateDescriptionRequiredBodyParam": { - "name": "ServiceUpdateDescription", - "in": "body", - "description": "The information necessary to update a service.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceUpdateDescription" - } - }, - "ImageStoreCopyDescriptionRequiredBodyParam": { - "name": "ImageStoreCopyDescription", - "in": "body", - "description": "Describes the copy description for the image store.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ImageStoreCopyDescription" - } - }, - "CodePackageNameOptionalQueryParam": { - "name": "CodePackageName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." - }, - "CodePackageNameRequiredQueryParam": { - "name": "CodePackageName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." - }, - "RestartDeployedCodePackageRequiredBodyParam": { - "name": "RestartDeployedCodePackageDescription", - "in": "body", - "description": "Describes the deployed code package on Service Fabric node to restart.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestartDeployedCodePackageDescription" - } - }, - "PartitionsHealthStateFilterOptionalQueryParam": { - "name": "PartitionsHealthStateFilter", - "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeployedServiceType_ServiceManifestNameOptionalQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." - }, - "ServiceTypeNameRequiredPathParam": { - "name": "serviceTypeName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Specifies the name of a Service Fabric service type." - }, - "ImageStoreContentPathRequiredPathParam": { - "name": "contentPath", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "Relative path to file or folder in the image store from its root." - }, - "PartitionKeyTypeOptionalQueryParam": { - "name": "PartitionKeyType", - "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false - }, - "PartitionKeyValueOptionalQueryParam": { - "name": "PartitionKeyValue", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named." - }, - "PreviousRspVersionOptionalQueryParam": { - "name": "PreviousRspVersion", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was got previously is stale." - }, - "DataLossModeRequiredQueryParam": { - "name": "DataLossMode", - "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "PartialDataLoss", - "FullDataLoss" - ], - "required": true, - "x-ms-enum": { - "name": "DataLossMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "PartialDataLoss", - "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition." - }, - { - "value": "FullDataLoss", - "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost." - } - ] - } - }, - "FaultOperationIdRequiredQueryParam": { - "name": "OperationId", - "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": true - }, - "ForceRequiredQueryParam": { - "name": "Force", - "description": "Indicates whether to gracefully rollback and clean up internal system state modified by executing the user-induced operation.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": true, - "default": false - }, - "NodeInstanceIdRequiredQueryParam": { - "name": "NodeInstanceId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API." - }, - "NodeTransitionTypeRequiredQueryParam": { - "name": "NodeTransitionType", - "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "Start", - "Stop" - ], - "required": true, - "x-ms-enum": { - "name": "NodeTransitionType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "Start", - "description": "Transition a stopped node to up." - }, - { - "value": "Stop", - "description": "Transition an up node to stopped." - } - ] - } - }, - "QuorumLossDurationRequiredQueryParam": { - "name": "QuorumLossDuration", - "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true - }, - "QuorumLossModeRequiredQueryParam": { - "name": "QuorumLossMode", - "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "QuorumReplicas", - "AllReplicas" - ], - "required": true, - "x-ms-enum": { - "name": "QuorumLossMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "QuorumReplicas", - "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss." - }, - { - "value": "AllReplicas" - } - ] - } - }, - "RestartPartitionModeRequiredQueryParam": { - "name": "RestartPartitionMode", - "description": "Describe which partitions to restart.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "AllReplicasOrInstances", - "OnlyActiveSecondaries" - ], - "required": true, - "x-ms-enum": { - "name": "RestartPartitionMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "AllReplicasOrInstances", - "description": "All replicas or instances in the partition are restarted at once." - }, - { - "value": "OnlyActiveSecondaries", - "description": "Only the secondary replicas are restarted." - } - ] - } - }, - "StateFilterRequiredQueryParam": { - "name": "StateFilter", - "description": "Used to filter on OperationState's for user-induced operations.\n65535 - select All\n1 - select Running\n2 - select RollingBack\n8 - select Completed\n16 - select Faulted\n32 - select Cancelled\n64 - select ForceCancelled", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true, - "default": 65535 - }, - "StopDurationInSecondsRequiredQueryParam": { - "name": "StopDurationInSeconds", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int32", - "minimum": 0, - "required": true, - "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up." - }, - "TypeFilterRequiredQueryParam": { - "name": "TypeFilter", - "description": "Used to filter on OperationType for user-induced operations.\n65535 - select all\n1 - select PartitionDataLoss.\n2 - select PartitionQuorumLoss.\n4 - select PartitionRestart.\n8 - select NodeTransition.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true, - "default": 65535 - }, - "DeployServicePackageToNodeRequiredBodyParam": { - "name": "DeployServicePackageToNodeDescription", - "in": "body", - "description": "Describes information for deploying a service package to a Service Fabric node.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/DeployServicePackageToNodeDescription" - } - }, - "ResumeApplicationUpgradeDescriptionRequiredBodyParam": { - "name": "ResumeApplicationUpgradeDescription", - "in": "body", - "description": "Describes the parameters for resuming an application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ResumeApplicationUpgradeDescription" - } - }, - "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": { - "name": "ApplicationUpgradeUpdateDescription", - "in": "body", - "description": "Parameters for updating an existing application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeUpdateDescription" - } - }, - "TimeoutOptionalQueryParam": { - "name": "timeout", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int64", - "required": false, - "minimum": 1, - "maximum": 4294967295, - "default": 60, - "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." - }, - "NameDescriptionRequiredBodyParam": { - "name": "NameDescription", - "in": "body", - "description": "Describes the Service Fabric name to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/NameDescription" - } - }, - "NameIdRequiredPathParam": { - "name": "nameId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The Service Fabric name, without the 'fabric:' URI scheme." - }, - "RecursiveOptionalQueryParam": { - "name": "Recursive", - "description": "Allows specifying that the search performed should be recursive.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeValuesOptionalQueryParam": { - "name": "IncludeValues", - "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "PropertyDescriptionRequiredBodyParam": { - "name": "PropertyDescription", - "in": "body", - "description": "Describes the Service Fabric property to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/PropertyDescription" - } - }, - "PropertyNameRequiredQueryParam": { - "name": "PropertyName", - "description": "Specifies the name of the property to get.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "PropertyBatchDescriptionListRequiredBodyParam": { - "name": "PropertyBatchDescriptionList", - "in": "body", - "description": "Describes the property batch operations to be submitted.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/PropertyBatchDescriptionList" - } - }, - "ImmediateOptionalQueryParam": { - "name": "Immediate", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "A flag which indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." - }, - "ExcludeHealthStatisticsOptionalQueryParam": { - "name": "ExcludeHealthStatistics", - "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": { - "name": "IncludeSystemApplicationHealthStatistics", - "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeHealthStateOptionalQueryParam": { - "name": "IncludeHealthState", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time." - }, - "BackupPolicyDescriptionRequiredBodyParam": { - "name": "BackupPolicyDescription", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "description": "Describes the backup policy.", - "schema": { - "$ref": "#/definitions/BackupPolicyDescription" - } - }, - "BackupPolicyNameRequiredPathParam": { - "name": "backupPolicyName", - "in": "path", - "description": "The name of the backup policy.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "EnableBackupDescriptionRequiredBodyParam": { - "name": "EnableBackupDescription", - "in": "body", - "description": "Specifies the parameters for enabling backup.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/EnableBackupDescription" - } - }, - "RestorePartitionDescriptionRequiredBodyParam": { - "name": "RestorePartitionDescription", - "in": "body", - "description": "Describes the parameters to restore the partition.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestorePartitionDescription" - } - }, - "RestoreTimeoutOptionalQueryParam": { - "name": "RestoreTimeout", - "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 10 - }, - "BackupPartitionDescriptionOptionalBodyParam": { - "name": "BackupPartitionDescription", - "in": "body", - "required": false, - "x-ms-parameter-location": "method", - "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.", - "schema": { - "$ref": "#/definitions/BackupPartitionDescription" - } - }, - "BackupTimeoutOptionalQueryParam": { - "name": "BackupTimeout", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.", - "default": 10 - }, - "LatestOptionalQueryParam": { - "name": "Latest", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.", - "required": false, - "default": false - }, - "StartDateTimeFilterOptionalQueryParam": { - "name": "StartDateTimeFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "date-time", - "required": false, - "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." - }, - "EndDateTimeFilterOptionalQueryParam": { - "name": "EndDateTimeFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "date-time", - "required": false, - "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." - }, - "GetBackupByStorageQueryDescriptionRequiredBodyParam": { - "name": "GetBackupByStorageQueryDescription", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "description": "Describes the filters and backup storage details to be used for enumerating backups.", - "schema": { - "$ref": "#/definitions/GetBackupByStorageQueryDescription" - } - }, - "RepairTaskApproveDescriptionRequiredBodyParam": { - "name": "RepairTaskApproveDescription", - "in": "body", - "description": "Describes the repair task to be approved.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskApproveDescription" - } - }, - "RepairTaskCancelDescriptionRequiredBodyParam": { - "name": "RepairTaskCancelDescription", - "in": "body", - "description": "Describes the repair task to be cancelled.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskCancelDescription" - } - }, - "RepairTaskDeleteDescriptionRequiredBodyParam": { - "name": "RepairTaskDeleteDescription", - "in": "body", - "description": "Describes the repair task to be deleted.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskDeleteDescription" - } - }, - "RepairTaskExecutorFilterOptionalQueryParam": { - "name": "ExecutorFilter", - "description": "The name of the repair executor whose claimed tasks should be included in the list.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false - }, - "RepairTaskIdFilterOptionalQueryParam": { - "name": "TaskIdFilter", - "description": "The repair task ID prefix to be matched.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false - }, - "RepairTaskRequiredBodyParam": { - "name": "RepairTask", - "in": "body", - "description": "Describes the repair task to be created or updated.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTask" - } - }, - "RepairTaskStateFilterOptionalQueryParam": { - "name": "StateFilter", - "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false - }, - "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": { - "name": "RepairTaskUpdateHealthPolicyDescription", - "in": "body", - "description": "Describes the repair task healthy policy to be updated.", - "x-ms-parameter-location": "method", - "required": true, - "schema": { - "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription" - } - }, - "UploadSessionIdRequiredQueryParam": { - "name": "session-id", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": true, - "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed." - }, - "UploadFileChunkContentRangeHeaderParam": { - "name": "Content-Range", - "in": "header", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes." - }, - "TailOptionalQueryParam": { - "name": "Tail", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs." - }, - "ChaosScheduleRequiredBodyParam": { - "name": "ChaosSchedule", - "in": "body", - "description": "Describes the schedule used by Chaos.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ChaosScheduleDescription" - } - }, - "StartTimeUtcRequiredQueryParam": { - "name": "StartTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." - }, - "EndTimeUtcRequiredQueryParam": { - "name": "EndTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." - }, - "EventsTypesFilterOptionalQueryParam": { - "name": "EventsTypesFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response." - }, - "ExcludeAnalysisEventsOptionalQueryParam": { - "name": "ExcludeAnalysisEvents", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "This param disables the retrieval of AnalysisEvents if true is passed." - }, - "SkipCorrelationLookupOptionalQueryParam": { - "name": "SkipCorrelationLookup", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated." - }, - "EventInstanceIdRequiredPathParam": { - "name": "eventInstanceId", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The EventInstanceId." - }, - "PreviousOptionalQueryParam": { - "name": "Previous", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.", - "required": false, - "default": false - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Service Fabric Client APIs", + "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.", + "version": "6.2.0.9" + }, + "host": "localhost:19080", + "schemes": [ + "http", + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/$/GetClusterManifest": { + "get": { + "operationId": "GetClusterManifest", + "summary": "Get the Service Fabric cluster manifest.", + "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster manifest information.", + "schema": { + "$ref": "#/definitions/ClusterManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealth": { + "get": { + "operationId": "GetClusterHealth", + "summary": "Gets the health of a Service Fabric cluster.", + "description": "Gets the health of a Service Fabric cluster.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric cluster using the specified policy.", + "description": "Gets the health of a Service Fabric cluster.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealthChunk": { + "get": { + "operationId": "GetClusterHealthChunk", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ReportClusterHealth": { + "post": { + "operationId": "ReportClusterHealth", + "summary": "Sends a health report on the Service Fabric cluster.", + "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedCodeVersions": { + "get": { + "operationId": "GetProvisionedFabricCodeVersionInfoList", + "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CodeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned code versions information.", + "schema": { + "$ref": "#/definitions/FabricCodeVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedConfigVersions": { + "get": { + "operationId": "GetProvisionedFabricConfigVersionInfoList", + "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned config versions information.", + "schema": { + "$ref": "#/definitions/FabricConfigVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeProgress": { + "get": { + "operationId": "GetClusterUpgradeProgress", + "summary": "Gets the progress of the current cluster upgrade.", + "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, gets the last state of the previous cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.", + "schema": { + "$ref": "#/definitions/ClusterUpgradeProgressObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfiguration": { + "get": { + "operationId": "GetClusterConfiguration", + "summary": "Get the Service Fabric standalone cluster configuration.", + "description": "Get the Service Fabric standalone cluster configuration. The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault and upgrade domain topologies, etc.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration information.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfigurationUpgradeStatus": { + "get": { + "operationId": "GetClusterConfigurationUpgradeStatus", + "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.", + "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeOrchestrationServiceState": { + "get": { + "operationId": "GetUpgradeOrchestrationServiceState", + "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/SetUpgradeOrchestrationServiceState": { + "post": { + "operationId": "SetUpgradeOrchestrationServiceState", + "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Provision": { + "post": { + "summary": "Provision the code or configuration packages of a Service Fabric cluster.", + "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.", + "operationId": "ProvisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been provisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Unprovision": { + "post": { + "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.", + "description": "Unprovision the code or configuration packages of a Service Fabric cluster. It is supported to unprovision code and configuration separately.", + "operationId": "UnprovisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been unprovisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RollbackUpgrade": { + "post": { + "summary": "Rollback the upgrade of a Service Fabric cluster.", + "description": "Rollback the code or configuration upgrade of a Service Fabric cluster.", + "operationId": "RollbackClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the rollback of a cluster upgrade has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Make the cluster upgrade move on to the next upgrade domain.", + "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.", + "operationId": "ResumeClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Upgrade": { + "post": { + "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.", + "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.", + "operationId": "StartClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/StartClusterConfigurationUpgrade": { + "post": { + "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.", + "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.", + "operationId": "StartClusterConfigurationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateUpgrade": { + "post": { + "operationId": "UpdateClusterUpgrade", + "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.", + "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetAadMetadata": { + "get": { + "operationId": "GetAadMetadata", + "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.", + "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "schemes": [ + "https" + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.", + "schema": { + "$ref": "#/definitions/AadMetadataObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes": { + "get": { + "summary": "Gets the list of nodes in the Service Fabric cluster.", + "description": "Gets the list of nodes in the Service Fabric cluster. The response includes the name, status, id, health, uptime, and other details about the node.", + "operationId": "GetNodeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get information about all nodes": { + "$ref": "./examples/GetNodeInfoList.json" + } + }, + "responses": { + "200": { + "description": "List of nodes in the cluster.", + "schema": { + "$ref": "#/definitions/PagedNodeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}": { + "get": { + "summary": "Gets the information about a specific node in the Service Fabric cluster.", + "description": "Gets the information about a specific node in the Service Fabric Cluster. The response includes the name, status, id, health, uptime, and other details about the node.", + "operationId": "GetNodeInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "responses": { + "200": { + "description": "A successful operation will return information about the node with the specified nodeName.", + "schema": { + "$ref": "#/definitions/NodeInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified nodeName is not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetHealth": { + "get": { + "operationId": "GetNodeHealth", + "summary": "Gets the health of a Service Fabric node.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetNodeHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric node, by using the specified health policy.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/ReportHealth": { + "post": { + "operationId": "ReportNodeHealth", + "summary": "Sends a health report on the Service Fabric node.", + "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetLoadInformation": { + "get": { + "operationId": "GetNodeLoadInfo", + "summary": "Gets the load information of a Service Fabric node.", + "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node load information.", + "schema": { + "$ref": "#/definitions/NodeLoadInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Deactivate": { + "post": { + "operationId": "DisableNode", + "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.", + "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node which is was deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Activate": { + "post": { + "operationId": "EnableNode", + "summary": "Activate a Service Fabric cluster node which is currently deactivated.", + "description": "Activates a Service Fabric cluster node which is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/RemoveNodeState": { + "post": { + "operationId": "RemoveNodeState", + "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.", + "description": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can comes back up with its state intact.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Restart": { + "post": { + "operationId": "RestartNode", + "summary": "Restarts a Service Fabric cluster node.", + "description": "Restarts a Service Fabric cluster node that is already started.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. For example, if there are 10 application types but a page only fits the first 3 application types, or if max results is set to 3, then 3 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationTypeInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationTypeInfoList-2.json" + }, + "Exclude application parameters from the result": { + "$ref": "./examples/GetApplicationTypeInfoList-3.json" + } + }, + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. For example, if there are 10 application types but a page only fits the first 3 application types, or if max results is set to 3, then 3 is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoListByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/$/Provision": { + "post": { + "operationId": "ProvisionApplicationType", + "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.", + "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { + "post": { + "operationId": "UnprovisionApplicationType", + "summary": "Removes or unregisters a Service Fabric application type from the cluster.", + "description": "Removes or unregisters a Service Fabric application type from the cluster. This operation can only be performed if all application instances of the application type has been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.", + "operationId": "GetServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoList-1.json" + } + }, + "responses": { + "200": { + "description": "List of service types that are supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", + "operationId": "GetServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A specific service type which supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfo" + } + }, + "204": { + "description": "A 204 response is returned if the specified service type is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { + "get": { + "summary": "Gets the manifest describing a service type.", + "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.", + "operationId": "GetServiceManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about the service type.", + "schema": { + "$ref": "#/definitions/ServiceTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.", + "operationId": "GetDeployedServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "List of information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.", + "operationId": "GetDeployedServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified service type of the application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/$/Create": { + "post": { + "summary": "Creates a Service Fabric application.", + "description": "Creates a Service Fabric application using the specified description.", + "operationId": "CreateApplication", + "x-ms-examples": { + "Create application.": { + "$ref": "./examples/CreateApplication-1.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "201": { + "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric application.", + "description": "Deletes an existing Service Fabric application. An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of the its services.", + "operationId": "DeleteApplication", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetLoadInformation": { + "get": { + "summary": "Gets load information about a Service Fabric application.", + "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.", + "operationId": "GetApplicationLoadInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "Information about the application load.", + "schema": { + "$ref": "#/definitions/ApplicationLoadInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications": { + "get": { + "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.", + "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.", + "operationId": "GetApplicationInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationInfoList-2.json" + } + }, + "responses": { + "200": { + "description": "List of applications created in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}": { + "get": { + "summary": "Gets information about a Service Fabric application.", + "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters and other details about the application.", + "operationId": "GetApplicationInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Get a specific application by application id": { + "$ref": "./examples/GetApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "Information about the application.", + "schema": { + "$ref": "#/definitions/ApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the service fabric application.", + "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.", + "operationId": "GetApplicationHealth", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested application health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetApplicationHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric application using the specified policy.", + "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportApplicationHealth", + "summary": "Sends a health report on the Service Fabric application.", + "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Upgrade": { + "post": { + "summary": "Starts upgrading an application in the Service Fabric cluster.", + "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.", + "operationId": "StartApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this application.", + "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.", + "operationId": "GetApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "The application upgrade details.", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/UpdateUpgrade": { + "post": { + "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.", + "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.", + "operationId": "UpdateApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Resumes upgrading an application in the Service Fabric cluster.", + "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.", + "operationId": "ResumeApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/RollbackUpgrade": { + "post": { + "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.", + "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to rollback the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.", + "operationId": "RollbackApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application has started to rollback. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications": { + "get": { + "operationId": "GetDeployedApplicationInfoList", + "summary": "Gets the list of applications deployed on a Service Fabric node.", + "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetDeployedApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetDeployedApplicationInfoList-2.json" + }, + "Include health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoList-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed application information.", + "schema": { + "$ref": "#/definitions/PagedDeployedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}": { + "get": { + "operationId": "GetDeployedApplicationInfo", + "summary": "Gets the information about an application deployed on a Service Fabric node.", + "description": "Gets the information about an application deployed on a Service Fabric node. This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get a specific deployed application by application ID and include the health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the information about the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": { + "get": { + "operationId": "GetDeployedApplicationHealth", + "summary": "Gets the information about health of an application deployed on a Service Fabric node.", + "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedApplicationHealthUsingPolicy", + "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.", + "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedApplicationHealth", + "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.", + "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { + "get": { + "summary": "Gets the manifest describing an application type.", + "description": "Gets the manifest describing an application type. The response contains the application manifest XML as a string.", + "operationId": "GetApplicationManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "Information about the node.", + "schema": { + "$ref": "#/definitions/ApplicationTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices": { + "get": { + "summary": "Gets the information about all services belonging to the application specified by the application id.", + "description": "Returns the information about all services belonging to the application specified by the application id.", + "operationId": "GetServiceInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "List of services in the cluster for the specified application.", + "schema": { + "$ref": "#/definitions/PagedServiceInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/{serviceId}": { + "get": { + "summary": "Gets the information about the specific service belonging to the Service Fabric application.", + "description": "Returns the information about the specified service belonging to the specified Service Fabric application.", + "operationId": "GetServiceInfo", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the specified service.", + "schema": { + "$ref": "#/definitions/ServiceInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified service is not part of the specified application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetApplicationName": { + "get": { + "summary": "Gets the name of the Service Fabric application for a service.", + "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.", + "operationId": "GetApplicationNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the name of the application for the specified service.", + "schema": { + "$ref": "#/definitions/ApplicationNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/Create": { + "post": { + "operationId": "CreateService", + "summary": "Creates the specified Service Fabric service.", + "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.", + "x-ms-examples": { + "Basic stateless service": { + "$ref": "./examples/CreateService-1.json" + }, + "Basic stateful service": { + "$ref": "./examples/CreateService-2.json" + }, + "Stateless service with dns name and auto scaling": { + "$ref": "./examples/CreateService-3.json" + }, + "Stateful service with named partitions and auto scaling": { + "$ref": "./examples/CreateService-4.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": { + "post": { + "summary": "Creates a Service Fabric service from the service template.", + "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.", + "operationId": "CreateServiceFromTemplate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric service.", + "description": "Deletes an existing Service Fabric service. A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.", + "operationId": "DeleteService", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Update": { + "post": { + "operationId": "UpdateService", + "summary": "Updates a Service Fabric service using the specified update description.", + "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Please note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.", + "x-ms-examples": { + "Stateless service": { + "$ref": "./examples/UpdateService-1.json" + }, + "Stateful service": { + "$ref": "./examples/UpdateService-2.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetDescription": { + "get": { + "summary": "Gets the description of an existing Service Fabric service.", + "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.", + "operationId": "GetServiceDescription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric service.", + "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.", + "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ReportHealth": { + "post": { + "operationId": "ReportServiceHealth", + "summary": "Sends a health report on the Service Fabric service.", + "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResolvePartition": { + "get": { + "operationId": "ResolveService", + "summary": "Resolve a Service Fabric partition.", + "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ResolvedServicePartition" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetPartitions": { + "get": { + "summary": "Gets the list of partitions of a Service Fabric service.", + "description": "Gets the list of partitions of a Service Fabric service. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "List of partitions of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/PagedServicePartitionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}": { + "get": { + "summary": "Gets the information about a Service Fabric partition.", + "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition.", + "schema": { + "$ref": "#/definitions/ServicePartitionInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified partitionId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetServiceName": { + "get": { + "summary": "Gets the name of the Service Fabric service for a partition.", + "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.", + "operationId": "GetServiceNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the name of the service for the specified partition.", + "schema": { + "$ref": "#/definitions/ServiceNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric partition.", + "description": "Gets the health information of the specified partition.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.", + "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ReportHealth": { + "post": { + "operationId": "ReportPartitionHealth", + "summary": "Sends a health report on the Service Fabric partition.", + "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetLoadInformation": { + "get": { + "summary": "Gets the load information of the specified Service Fabric partition.", + "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.", + "operationId": "GetPartitionLoadInformation", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition's last reported load metrics.", + "schema": { + "$ref": "#/definitions/PartitionLoadInformation" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResetLoad": { + "post": { + "operationId": "ResetPartitionLoad", + "summary": "Resets the current load of a Service Fabric partition.", + "description": "Resets the current load of a Service Fabric partition to the default load for the service.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Recover": { + "post": { + "operationId": "RecoverPartition", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/$/{serviceId}/$/GetPartitions/$/Recover": { + "post": { + "operationId": "RecoverServicePartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverSystemPartitions": { + "post": { + "operationId": "RecoverSystemPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverAllPartitions": { + "post": { + "operationId": "RecoverAllPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CreateRepairTask": { + "post": { + "operationId": "CreateRepairTask", + "summary": "Creates a new repair task.", + "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CancelRepairTask": { + "post": { + "operationId": "CancelRepairTask", + "summary": "Requests the cancellation of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/DeleteRepairTask": { + "post": { + "operationId": "DeleteRepairTask", + "summary": "Deletes a completed repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetRepairTaskList": { + "get": { + "operationId": "GetRepairTaskList", + "summary": "Gets a list of repair tasks matching the given filters.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.", + "schema": { + "$ref": "#/definitions/RepairTaskList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ForceApproveRepairTask": { + "post": { + "operationId": "ForceApproveRepairTask", + "summary": "Forces the approval of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairTaskHealthPolicy": { + "post": { + "operationId": "UpdateRepairTaskHealthPolicy", + "summary": "Updates the health policy of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairExecutionState": { + "post": { + "operationId": "UpdateRepairExecutionState", + "summary": "Updates the execution state of a repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas": { + "get": { + "summary": "Gets the information about replicas of a Service Fabric service partition.", + "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the id, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the replicas of the specified partition.", + "schema": { + "$ref": "#/definitions/PagedReplicaInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { + "get": { + "summary": "Gets the information about a replica of a Service Fabric partition.", + "description": "The response includes the id, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the specified replicas of the specified partition of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/ReplicaInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { + "get": { + "operationId": "GetReplicaHealth", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.", + "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetReplicaHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.", + "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health information.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { + "post": { + "operationId": "ReportReplicaHealth", + "summary": "Sends a health report on the Service Fabric replica.", + "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaInfoList", + "summary": "Gets the list of replicas deployed on a Service Fabric node.", + "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfo", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information include service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information include service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": { + "post": { + "operationId": "RestartReplica", + "summary": "Restarts a service replica of a persisted service running on a node.", + "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": { + "post": { + "operationId": "RemoveReplica", + "summary": "Removes a service replica running on a node.", + "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services.In addition, the forceRemove flag impacts all other replicas hosted in the same process.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": { + "get": { + "operationId": "GetDeployedServicePackageInfoList", + "summary": "Gets the list of service packages deployed on a Service Fabric node.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": { + "get": { + "operationId": "GetDeployedServicePackageInfoListByName", + "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information." + }, + "204": { + "description": "An empty response is returned if the specified service package from the application is not deployed on the node.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { + "get": { + "operationId": "GetDeployedServicePackageHealth", + "summary": "Gets the information about health of an service package for a specific application deployed for a Service Fabric node and application.", + "description": "Gets the information about health of service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedServicePackageHealthUsingPolicy", + "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.", + "description": "Gets the information about health of an service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service Package" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedServicePackageHealth", + "summary": "Sends a health report on the Service Fabric deployed service package.", + "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/DeployServicePackage": { + "post": { + "operationId": "DeployServicePackageToNode", + "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.", + "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": { + "get": { + "operationId": "GetDeployedCodePackageInfoList", + "summary": "Gets the list of code packages deployed on a Service Fabric node.", + "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed code packages information.", + "schema": { + "$ref": "#/definitions/DeployedCodePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": { + "post": { + "operationId": "RestartDeployedCodePackage", + "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.", + "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": { + "get": { + "operationId": "GetContainerLogsDeployedOnNode", + "summary": "Gets the container logs for container deployed on a Service Fabric node.", + "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get container logs for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json" + }, + "Get last 10 lines of container logs": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json" + }, + "Get container logs of previous dead container for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": { + "post": { + "operationId": "InvokeContainerApi", + "summary": "Invoke container API on a container deployed on a Service Fabric node.", + "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.", + "x-ms-examples": { + "Get container logs": { + "$ref": "./examples/InvokeContainerApi.json" + }, + "Update container": { + "$ref": "./examples/InvokeContainerApi_Post.json" + } + }, + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContainerApiRequiredBodyParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerApiResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/$/Create": { + "put": { + "summary": "Creates a Service Fabric compose deployment.", + "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created it's status can be tracked via `GetComposeDeploymentStatus` API.", + "operationId": "CreateComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}": { + "get": { + "summary": "Gets information about a Service Fabric compose deployment.", + "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status and other details about the deployment.", + "operationId": "GetComposeDeploymentStatus", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Information about the compose deployment.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments": { + "get": { + "summary": "Gets the list of compose deployments created in the Service Fabric cluster.", + "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.", + "operationId": "GetComposeDeploymentStatusList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "List of status of compose deployments in the cluster.", + "schema": { + "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.", + "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.", + "operationId": "GetComposeDeploymentUpgradeProgress", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Details about the compose deployment upgrade.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric compose deployment from cluster.", + "description": "Deletes an existing Service Fabric compose deployment.", + "operationId": "RemoveComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Upgrade": { + "post": { + "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.", + "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.", + "operationId": "StartComposeDeploymentUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos": { + "get": { + "operationId": "GetChaos", + "summary": "Get the status of Chaos.", + "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the status of Chaos.", + "schema": { + "$ref": "#/definitions/Chaos" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Start": { + "post": { + "operationId": "StartChaos", + "summary": "Starts Chaos in the cluster.", + "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nPlease refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-controlled-chaos) for more details.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ChaosParametersRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Stop": { + "post": { + "operationId": "StopChaos", + "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.", + "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Events": { + "get": { + "operationId": "GetChaosEvents", + "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.", + "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.", + "x-ms-examples": { + "Get Chaos events given a time range": { + "$ref": "./examples/GetChaosEvents.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "Next segment of Chaos events.", + "schema": { + "$ref": "#/definitions/ChaosEventsSegment" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Schedule": { + "get": { + "operationId": "GetChaosSchedule", + "summary": "Get the Chaos Schedule defining when and how to run Chaos.", + "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "PostChaosSchedule", + "summary": "Set the schedule used by Chaos.", + "description": "Set the Chaos Schedule currently in use by Chaos. Chaos will automatically schedule runs based on the Chaos Schedule.\nThe version in the provided input schedule must match the version of the Chaos Schedule on the server.\nIf the version provided does not match the version on the server, the Chaos Schedule is not updated.\nIf the version provided matches the version on the server, then the Chaos Schedule is updated and the version of the Chaos Schedule on the server is incremented up by one and wraps back to 0 after 2,147,483,647.\nIf Chaos is running when this call is made, the call will fail.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ChaosScheduleRequiredBodyParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}": { + "put": { + "summary": "Uploads contents of the file to the image store.", + "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.", + "operationId": "UploadFile", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the image store content information.", + "description": "Returns the information about the image store content at the specified contentPath relative to the root of the image store.", + "operationId": "GetImageStoreContent", + "x-ms-examples": { + "Get information about image store content under a given relative path": { + "$ref": "./examples/GetImageStoreContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes existing image store content.", + "description": "Deletes existing image store content being found within the given image store relative path. This can be used to delete uploaded application packages once they are provisioned.", + "operationId": "DeleteImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore": { + "get": { + "summary": "Gets the content information at the root of the image store.", + "description": "Returns the information about the image store content at the root of the image store.", + "operationId": "GetImageStoreRootContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/Copy": { + "post": { + "summary": "Copies image store content internally", + "description": "Copies the image store content from the source image store relative path to the destination image store relative path.", + "operationId": "CopyImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/DeleteUploadSession": { + "delete": { + "summary": "Cancels an image store upload session.", + "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.", + "operationId": "DeleteImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/CommitUploadSession": { + "post": { + "summary": "Commit an image store upload session.", + "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ", + "operationId": "CommitImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by ID.", + "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionById", + "x-ms-examples": { + "Get information about image store upload session by a given ID": { + "$ref": "./examples/GetUploadSessionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by relative path.", + "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionByPath", + "x-ms-examples": { + "Get information about image store upload session by a given relative path": { + "$ref": "./examples/GetUploadSessionByPath.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/UploadChunk": { + "put": { + "summary": "Uploads a file chunk to the image store relative path.", + "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.", + "operationId": "UploadFileChunk", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureCommand": { + "post": { + "operationId": "InvokeInfrastructureCommand", + "summary": "Invokes an administrative command on the given Infrastructure Service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureQuery": { + "get": { + "operationId": "InvokeInfrastructureQuery", + "summary": "Invokes a read-only query on the given infrastructure service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": { + "post": { + "operationId": "StartDataLoss", + "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.", + "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode\nPartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\nFullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/DataLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": { + "get": { + "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.", + "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.", + "operationId": "GetDataLossProgress", + "x-ms-examples": { + "Gets information about a partition data loss operation. In this case the operation has a State of Completed": { + "$ref": "./examples/GetDataLossProgress.json" + }, + "Get information about a partition data loss operation. In this case the operation is a State of Running": { + "$ref": "./examples/GetDataLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of the partition data loss operation.", + "schema": { + "$ref": "#/definitions/PartitionDataLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": { + "post": { + "operationId": "StartQuorumLoss", + "summary": "Induces quorum loss for a given stateful service partition.", + "description": "Induces quorum loss for a given stateful service partition. This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": { + "get": { + "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.", + "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.", + "operationId": "GetQuorumLossProgress", + "x-ms-examples": { + "Gets information about a completed quorum loss operation": { + "$ref": "./examples/GetQuorumLossProgress.json" + }, + "Gets information about a running quorum operation operation": { + "$ref": "./examples/GetQuorumLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition quorum loss operation.", + "schema": { + "$ref": "#/definitions/PartitionQuorumLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": { + "post": { + "operationId": "StartPartitionRestart", + "summary": "This API will restart some or all replicas or instances of the specified partition.", + "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": { + "get": { + "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.", + "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.", + "operationId": "GetPartitionRestartProgress", + "x-ms-examples": { + "Get information a completed PartitionRestart operation": { + "$ref": "./examples/GetPartitionRestartProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition restart operation.", + "schema": { + "$ref": "#/definitions/PartitionRestartProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/StartTransition/": { + "post": { + "operationId": "StartNodeTransition", + "summary": "Starts or stops a cluster node.", + "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": { + "get": { + "summary": "Gets the progress of an operation started using StartNodeTransition.", + "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.", + "operationId": "GetNodeTransitionProgress", + "x-ms-examples": { + "Gets information about a completed NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress.json" + }, + "Gets information about a running NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a node transition operation.", + "schema": { + "$ref": "#/definitions/NodeTransitionProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/": { + "get": { + "operationId": "GetFaultOperationList", + "summary": "Gets a list of user-induced fault operations filtered by provided input.", + "description": "Gets the a list of user-induced fault operations filtered by provided input.", + "x-ms-examples": { + "Gets information on fault operations": { + "$ref": "./examples/GetFaultOperationList.json" + } + }, + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TypeFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/StateFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/OperationStatusList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/$/Cancel": { + "post": { + "operationId": "CancelOperation", + "summary": "Cancels a user-induced fault operation.", + "description": "The following is a list of APIs that start fault operations that may be cancelled using CancelOperation -\n- StartDataLoss\n- StartQuorumLoss\n- StartPartitionRestart\n- StartNodeTransition\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will/is be cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/ForceRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/$/Create": { + "post": { + "operationId": "CreateBackupPolicy", + "summary": "Creates a backup policy.", + "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.", + "x-ms-examples": { + "Create a time based backup policy with Azure as backup location": { + "$ref": "./examples/CreateBackupPolicy-1.json" + }, + "Create a frequency based backup policy with file share as backup location": { + "$ref": "./examples/CreateBackupPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "201": { + "description": "A sucessful operation returns 201 status code and creates a new backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": { + "post": { + "operationId": "DeleteBackupPolicy", + "summary": "Deletes the backup policy.", + "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.", + "x-ms-examples": { + "Delete backup policy": { + "$ref": "./examples/DeleteBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and deletes the backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies": { + "get": { + "operationId": "GetBackupPolicyList", + "summary": "Gets all the backup policies configured.", + "description": "Get a list of all the backup policies configured.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupPolicyList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupPolicyList-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and paged list of backup policies.", + "schema": { + "$ref": "#/definitions/PagedBackupPolicyDescriptionList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}": { + "get": { + "operationId": "GetBackupPolicyByName", + "summary": "Gets a particular backup policy by name.", + "description": "Gets a particular backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Get backup policy by name": { + "$ref": "./examples/GetBackupPolicyByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the backup policy description.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": { + "get": { + "operationId": "GetAllEntitiesBackedUpByPolicy", + "summary": "Gets the list of backup entities that are associated with this policy.", + "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.", + "schema": { + "$ref": "#/definitions/PagedBackupEntityList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": { + "post": { + "operationId": "UpdateBackupPolicy", + "summary": "Updates the backup policy.", + "description": "Updates the backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Update backup policy": { + "$ref": "./examples/UpdateBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A sucessful operation resturns 200 status code and updates the backup policy description." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/EnableBackup": { + "post": { + "operationId": "EnableApplicationBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable application backup": { + "$ref": "./examples/EnableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/DisableBackup": { + "post": { + "operationId": "DisableApplicationBackup", + "summary": "Disables periodic backup of Service Fabric application.", + "description": "Disables periodic backup of Service Fabric application which was previously enabled.", + "x-ms-examples": { + "Disable application backup": { + "$ref": "./examples/DisableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetApplicationBackupConfigurationInfo", + "summary": "Gets the Service Fabric application backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackups": { + "get": { + "operationId": "GetApplicationBackupList", + "summary": "Gets the list of backups available for every partition in this application.", + "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetApplicationBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetApplicationBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendApplicationBackup", + "summary": "Suspends periodic backup for the specified Service Fabric application.", + "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.", + "x-ms-examples": { + "Suspend application backup": { + "$ref": "./examples/SuspendApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeApplicationBackup", + "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.", + "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume application backup": { + "$ref": "./examples/ResumeApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/EnableBackup": { + "post": { + "operationId": "EnableServiceBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable service backup": { + "$ref": "./examples/EnableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/DisableBackup": { + "post": { + "operationId": "DisableServiceBackup", + "summary": "Disables periodic backup of Service Fabric service which was previously enabled.", + "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.", + "x-ms-examples": { + "Disable service backup": { + "$ref": "./examples/DisableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetServiceBackupConfigurationInfo", + "summary": "Gets the Service Fabric service backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackups": { + "get": { + "operationId": "GetServiceBackupList", + "summary": "Gets the list of backups available for every partition in this service.", + "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetServiceBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetServiceBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendServiceBackup", + "summary": "Suspends periodic backup for the specified Service Fabric service.", + "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.", + "x-ms-examples": { + "Suspend service backup": { + "$ref": "./examples/SuspendServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeServiceBackup", + "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.", + "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume service backup": { + "$ref": "./examples/ResumeServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/EnableBackup": { + "post": { + "operationId": "EnablePartitionBackup", + "summary": "Enables periodic backup of the stateful persisted partition.", + "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable partition backup": { + "$ref": "./examples/EnablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/DisableBackup": { + "post": { + "operationId": "DisablePartitionBackup", + "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.", + "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.", + "x-ms-examples": { + "Disable partition backup": { + "$ref": "./examples/DisablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetPartitionBackupConfigurationInfo", + "summary": "Gets the partition backup configuration information", + "description": "Gets the Service Fabric Backup configuration information for the specified partition.", + "x-ms-examples": { + "Get partition backup configuration information": { + "$ref": "./examples/GetPartitionBackupConfigurationInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.", + "schema": { + "$ref": "#/definitions/PartitionBackupConfigurationInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackups": { + "get": { + "operationId": "GetPartitionBackupList", + "summary": "Gets the list of backups available for the specified partition.", + "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetPartitionBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetPartitionBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetPartitionBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetPartitionBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendPartitionBackup", + "summary": "Suspends periodic backup for the specified partition.", + "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.", + "x-ms-examples": { + "Suspend partition backup": { + "$ref": "./examples/SuspendPartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResumeBackup": { + "post": { + "operationId": "ResumePartitionBackup", + "summary": "Resumes periodic backup of partition which was previously suspended.", + "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume partition backup": { + "$ref": "./examples/ResumePartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Backup": { + "post": { + "operationId": "BackupPartition", + "summary": "Triggers backup of the partition's state.", + "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.", + "x-ms-examples": { + "Backup partition": { + "$ref": "./examples/BackupPartition-1.json" + }, + "Backup partition to a specific Azure storage account": { + "$ref": "./examples/BackupPartition-2.json" + }, + "Backup partition to a specific on-premise file share": { + "$ref": "./examples/BackupPartition-3.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/BackupTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupProgress": { + "get": { + "operationId": "GetPartitionBackupProgress", + "summary": "Gets details for the latest backup triggered for this partition.", + "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get backup operation progress": { + "$ref": "./examples/GetPartitionBackupProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and backup progress details.", + "schema": { + "$ref": "#/definitions/BackupProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Restore": { + "post": { + "operationId": "RestorePartition", + "summary": "Triggers restore of the state of the partition using the specified restore partition description.", + "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.", + "x-ms-examples": { + "Trigger partition restore": { + "$ref": "./examples/RestorePartition.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetRestoreProgress": { + "get": { + "operationId": "GetPartitionRestoreProgress", + "summary": "Gets details for the latest restore operation triggered for this partition.", + "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get restore operation progress": { + "$ref": "./examples/GetPartitionRestoreProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and restore progress details.", + "schema": { + "$ref": "#/definitions/RestoreProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/$/GetBackups": { + "post": { + "operationId": "GetBackupsFromBackupLocation", + "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.", + "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupsFromBackupLocation-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupsFromBackupLocation-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/$/Create": { + "post": { + "summary": "Creates a Service Fabric name.", + "description": "Creates the specified Service Fabric name.", + "operationId": "CreateName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Create new name": { + "$ref": "examples/CreateName-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "201": { + "description": "A successful response means that the name has been created." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}": { + "get": { + "summary": "Returns whether the Service Fabric name exists.", + "description": "Returns whether the specified Service Fabric name exists.", + "operationId": "GetNameExistsInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name exists." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes a Service Fabric name.", + "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.", + "operationId": "DeleteName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetSubNames": { + "get": { + "summary": "Enumerates all the Service Fabric names under a given name.", + "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page. Querying a name that doesn't exist will fail.", + "operationId": "GetSubNameInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RecursiveOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get sub names": { + "$ref": "examples/GetSubNameInfoList-1.json" + }, + "Recursively search sub names": { + "$ref": "examples/GetSubNameInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetSubNameInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric names.", + "schema": { + "$ref": "#/definitions/PagedSubNameInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties": { + "get": { + "summary": "Gets information on all Service Fabric properties under a given name.", + "description": "A Service Fabric name can have one or more named properties that stores custom information. This operation gets the information about these properties in a paged list. The information include name, value and metadata about each of the properties.", + "operationId": "GetPropertyInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/IncludeValuesOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info list": { + "$ref": "examples/GetPropertyInfoList-1.json" + }, + "Get property info list with values": { + "$ref": "examples/GetPropertyInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetPropertyInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric properties.", + "schema": { + "$ref": "#/definitions/PagedPropertyInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperty": { + "put": { + "summary": "Creates or updates a Service Fabric property.", + "description": "Creates or updates the specified Service Fabric property under a given name.", + "operationId": "PutProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Put property": { + "$ref": "examples/PutProperty-1.json" + }, + "Put custom property": { + "$ref": "examples/PutProperty-2.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been created or updated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the specified Service Fabric property.", + "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.", + "operationId": "GetPropertyInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info": { + "$ref": "examples/GetPropertyInfo-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "Details on the Service Fabric property.", + "schema": { + "$ref": "#/definitions/PropertyInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes the specified Service Fabric property.", + "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.", + "operationId": "DeleteProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties/$/SubmitBatch": { + "post": { + "summary": "Submits a property batch.", + "description": "Submits a batch of property operations. Either all or none of the operations will be committed.", + "operationId": "SubmitPropertyBatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Property batch operation": { + "$ref": "examples/SubmitPropertyBatch-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property batch succeeded.", + "schema": { + "$ref": "#/definitions/SuccessfulPropertyBatchInfo" + } + }, + "409": { + "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", + "schema": { + "$ref": "#/definitions/FailedPropertyBatchInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Cluster/Events": { + "get": { + "summary": "Gets all Cluster-related events.", + "description": "The response is list of ClusterEvent objects.", + "operationId": "GetClusterEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Cluster-related events": { + "$ref": "./examples/GetClusterEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ClusterEvent.", + "schema": { + "$ref": "#/definitions/ClusterEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Containers/Events": { + "get": { + "summary": "Gets all Containers-related events.", + "description": "The response is list of ContainerInstanceEvent objects.", + "operationId": "GetContainersEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "responses": { + "200": { + "description": "List of events objects with base type ContainerInstanceEvent.", + "schema": { + "$ref": "#/definitions/ContainerInstanceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/{nodeName}/$/Events": { + "get": { + "summary": "Gets a Node-related events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodeEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Node-related events": { + "$ref": "./examples/GetNodeEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/Events": { + "get": { + "summary": "Gets all Nodes-related Events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Nodes-related events": { + "$ref": "./examples/GetNodesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/{applicationId}/$/Events": { + "get": { + "summary": "Gets an Application-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Application-related events": { + "$ref": "./examples/GetApplicationEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/Events": { + "get": { + "summary": "Gets all Applications-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Applications-related events": { + "$ref": "./examples/GetApplicationsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/{serviceId}/$/Events": { + "get": { + "summary": "Gets a Service-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServiceEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Service-related events": { + "$ref": "./examples/GetServiceEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/Events": { + "get": { + "summary": "Gets all Services-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServicesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Services-related events": { + "$ref": "./examples/GetServicesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Events": { + "get": { + "summary": "Gets a Partition-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition-related events": { + "$ref": "./examples/GetPartitionEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/Events": { + "get": { + "summary": "Gets all Partitions-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partitions-related events": { + "$ref": "./examples/GetPartitionsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": { + "get": { + "summary": "Gets a Partition Replica-related events.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicaEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replica-related events": { + "$ref": "./examples/GetReplicaEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": { + "get": { + "summary": "Gets all Replicas-related events for a Partition.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicasEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replicas-related events": { + "$ref": "./examples/GetReplicasEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": { + "get": { + "summary": "Gets all correlated events for a given event.", + "description": "The response is list of FabricEvents.", + "operationId": "GetCorrelatedEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventInstanceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Correlated events": { + "$ref": "./examples/GetCorrelatedEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type FabricEvent.", + "schema": { + "$ref": "#/definitions/EventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + } + }, + "definitions": { + "AadMetadata": { + "type": "object", + "description": "Azure Active Directory metadata used for secured connection to cluster.", + "properties": { + "authority": { + "type": "string", + "description": "The AAD authority url." + }, + "client": { + "type": "string", + "description": "The AAD client application Id." + }, + "cluster": { + "type": "string", + "description": "The AAD cluster application Id." + }, + "login": { + "type": "string", + "description": "The AAD login url." + }, + "redirect": { + "type": "string", + "description": "The client application redirect address." + }, + "tenant": { + "type": "string", + "description": "The AAD tenant Id." + } + } + }, + "AadMetadataObject": { + "type": "object", + "description": "Azure Active Directory metadata object used for secured connection to cluster.", + "properties": { + "type": { + "type": "string", + "description": "The client authentication method." + }, + "metadata": { + "$ref": "#/definitions/AadMetadata", + "description": "Azure Active Directory metadata used for secured connection to cluster." + } + } + }, + "AnalysisEventMetadata": { + "type": "object", + "description": "Metadata about an Analysis Event.", + "properties": { + "Delay": { + "type": "string", + "format": "duration", + "description": "The analysis delay." + }, + "Duration": { + "type": "string", + "format": "duration", + "description": "The duration of analysis." + } + } + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application.", + "enum": [ + "Invalid", + "ServiceFabricApplicationDescription", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535." + }, + { + "value": "ServiceFabricApplicationDescription", + "description": "Indicates the application is defined by a Service Fabric application description. The value is 0." + }, + { + "value": "Compose", + "description": "Indicates the application is defined by compose file(s). The value is 1." + } + ] + } + }, + "ApplicationEvent": { + "description": "Represents the base for all Application Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ApplicationEvent", + "properties": { + "ApplicationId": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + } + }, + "required": [ + "ApplicationId" + ] + } + ], + "x-ms-discriminator-value": "ApplicationEvent" + }, + "ApplicationEventList": { + "description": "A list of ApplicationEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationEvent" + } + }, + "ApplicationHealth": { + "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ApplicationHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthState" + }, + "description": "Service health states as found in the health store." + }, + "DeployedApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthState" + }, + "description": "Deployed application health states as found in the health store." + } + } + } + ] + }, + "ApplicationHealthEvaluation": { + "x-ms-discriminator-value": "Application", + "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationHealthEvaluation", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "ApplicationHealthPolicies": { + "type": "object", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.", + "default": 0 + }, + "DefaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "ServiceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthPolicyMapItem" + }, + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ApplicationHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ApplicationHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "$ref": "#/definitions/ApplicationName", + "description": "The key of the application health policy map item. This is the name of the application." + }, + "Value": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application." + } + } + }, + "ApplicationHealthState": { + "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ApplicationHealthState", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ] + }, + "ApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunk", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ServiceHealthStateChunks": { + "$ref": "#/definitions/ServiceHealthStateChunkList", + "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "DeployedApplicationHealthStateChunks": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunkList", + "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "ApplicationHealthStateChunkList": { + "type": "object", + "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunkList", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateChunk" + }, + "description": "The list of application health state chunks that respect the input filters in the chunk query." + } + } + } + ] + }, + "ApplicationHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.", + "properties": { + "ApplicationNameFilter": { + "type": "string", + "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "ApplicationTypeNameFilter": { + "type": "string", + "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ServiceFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateFilter" + }, + "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name." + }, + "DeployedApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node." + } + } + }, + "ApplicationId": { + "type": "string", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationInfo": { + "type": "object", + "description": "Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/ApplicationStatus", + "description": "The status of the application." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ApplicationDefinitionKind": { + "$ref": "#/definitions/ApplicationDefinitionKind", + "description": "The mechanism used to define a Service Fabric application." + } + } + }, + "ApplicationLoadInfo": { + "type": "object", + "description": "Load Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero." + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero." + }, + "NodeCount": { + "type": "integer", + "format": "int64", + "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero." + }, + "ApplicationLoadMetricInformation": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationName": { + "type": "string", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationNameInfo": { + "type": "object", + "description": "Information about the application name.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + }, + "ApplicationPackageCleanupPolicy": { + "type": "string", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.", + "enum": [ + "Invalid", + "Default", + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "ApplicationPackageCleanupPolicy", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero." + }, + { + "value": "Default", + "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1." + }, + { + "value": "Automatic", + "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2." + }, + { + "value": "Manual", + "description": "Indicates that the user has to explicitly clean up the application package. The value is 3." + } + ] + } + }, + "ApplicationParameter": { + "type": "object", + "description": "Describes an application parameter override to be applied when creating or upgrading an application.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The name of the parameter." + }, + "Value": { + "type": "string", + "description": "The value of the parameter." + } + } + }, + "ApplicationParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "Applications", + "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ApplicationStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the application status is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the application status is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the application status is creating. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the application status is deleting. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5." + } + ] + } + }, + "ApplicationTypeApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "ApplicationTypeApplications", + "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationTypeApplicationsHealthEvaluation", + "properties": { + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications of the application type found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health." + } + } + } + ] + }, + "ApplicationTypeDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application type.", + "enum": [ + "Invalid", + "ServiceFabricApplicationPackage", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationTypeDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0." + }, + { + "value": "ServiceFabricApplicationPackage", + "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1." + }, + { + "value": "Compose", + "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2." + } + ] + } + }, + "ApplicationTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem" + }, + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + }, + "ApplicationTypeHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ApplicationTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the application type health policy map item. This is the name of the application type." + }, + "Value": { + "type": "integer", + "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100." + } + } + }, + "ApplicationTypeInfo": { + "type": "object", + "description": "Information about an application type.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Version": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "DefaultParameterList": { + "$ref": "#/definitions/ApplicationTypeParameterList", + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "Status": { + "$ref": "#/definitions/ApplicationTypeStatus", + "description": "The status of the application type." + }, + "StatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the application type." + }, + "ApplicationTypeDefinitionKind": { + "$ref": "#/definitions/ApplicationTypeDefinitionKind", + "description": "The mechanism used to define a Service Fabric application type." + } + } + }, + "PagedApplicationTypeInfoList": { + "type": "object", + "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application type information.", + "items": { + "$ref": "#/definitions/ApplicationTypeInfo" + } + } + } + }, + "ApplicationTypeManifest": { + "type": "object", + "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "ApplicationTypeStatus": { + "type": "string", + "description": "The status of the application type.", + "enum": [ + "Invalid", + "Provisioning", + "Available", + "Unprovisioning", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationTypeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the application type is being provisioned in the cluster. The value is 1." + }, + { + "value": "Available", + "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3." + }, + { + "value": "Failed", + "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4." + } + ] + } + }, + "ApplicationUnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "ApplicationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "Name", + "TargetApplicationTypeVersion", + "UpgradeKind", + "Parameters" + ] + }, + "ApplicationUpgradeProgressInfo": { + "type": "object", + "description": "Describes the parameters for an application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ApplicationUpgradeDescription", + "description": "Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription." + }, + "UpgradeDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + } + } + }, + "ByteArray": { + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.", + "type": "array", + "items": { + "type": "integer" + } + }, + "ClusterConfiguration": { + "type": "object", + "description": "Information about the standalone cluster configuration.", + "properties": { + "ClusterConfiguration": { + "type": "string", + "description": "The contents of the cluster configuration file." + } + } + }, + "ClusterEvent": { + "description": "Represents the base for all Cluster Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ClusterEvent" + } + ], + "x-ms-discriminator-value": "ClusterEvent" + }, + "ClusterEventList": { + "description": "A list of ClusterEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterEvent" + } + }, + "ClusterHealth": { + "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ClusterHealth", + "properties": { + "NodeHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthState" + }, + "description": "Cluster node health states as found in the health store." + }, + "ApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthState" + }, + "description": "Cluster application health states as found in the health store." + } + } + } + ] + }, + "ClusterHealthChunk": { + "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.", + "type": "object", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies." + }, + "NodeHealthStateChunks": { + "$ref": "#/definitions/NodeHealthStateChunkList", + "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "ApplicationHealthStateChunks": { + "$ref": "#/definitions/ApplicationHealthStateChunkList", + "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + }, + "ClusterHealthChunkQueryDescription": { + "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.", + "properties": { + "NodeFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateFilter" + }, + "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName." + }, + "ApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ApplicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "ClusterHealthPolicies": { + "description": "Health policies to evaluate cluster health.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + } + } + }, + "ClusterHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.", + "default": 0 + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.", + "default": 0 + }, + "ApplicationTypeHealthPolicyMap": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMap", + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + } + } + }, + "ClusterManifest": { + "type": "object", + "description": "Information about the cluster manifest.", + "properties": { + "Manifest": { + "type": "string", + "description": "The contents of the cluster manifest file." + } + } + }, + "ContainerApiRequestBody": { + "type": "object", + "description": "parameters for making container API call.", + "properties": { + "HttpVerb": { + "type": "string", + "description": "HTTP verb of container REST API, defaults to \"GET\"" + }, + "UriPath": { + "type": "string", + "description": "URI path of container REST API" + }, + "Content-Type": { + "type": "string", + "description": "Content type of container REST API request, defaults to \"application/json\"" + }, + "Body": { + "type": "string", + "description": "HTTP request body of container REST API" + } + }, + "required": [ + "UriPath" + ] + }, + "ContainerApiResponse": { + "type": "object", + "description": "Response body that wraps container API result.", + "properties": { + "ContainerApiResult": { + "$ref": "#/definitions/ContainerApiResult", + "description": "Container API result." + } + }, + "required": [ + "ContainerApiResult" + ] + }, + "ContainerApiResult": { + "type": "object", + "description": "Container API result.", + "properties": { + "Status": { + "type": "integer", + "description": "HTTP status code returned by the target container API" + }, + "Content-Type": { + "type": "string", + "description": "HTTP content type" + }, + "Content-Encoding": { + "type": "string", + "description": "HTTP content encoding" + }, + "Body": { + "type": "string", + "description": "container API result body" + } + }, + "required": [ + "Status" + ] + }, + "ContainerInstanceEvent": { + "description": "Represents the base for all Container Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ContainerInstanceEvent" + } + ], + "x-ms-discriminator-value": "ContainerInstanceEvent" + }, + "ContainerInstanceEventList": { + "description": "A list of ContainerInstanceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerInstanceEvent" + } + }, + "ContinuationToken": { + "type": "string", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "CurrentUpgradeDomainProgressInfo": { + "type": "object", + "description": "Information about the current in-progress upgrade domain.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "CurrentUpgradeDomainDuration": { + "type": "string", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "DeactivationIntentDescription": { + "description": "Describes the intent or reason for deactivating the node.", + "properties": { + "DeactivationIntent": { + "type": "string", + "description": "Describes the intent or reason for deactivating the node. The possible values are following.", + "enum": [ + "Pause", + "Restart", + "RemoveData" + ], + "x-ms-enum": { + "name": "DeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates the intent is for the node to remove data. The value is 3." + } + ] + } + } + } + }, + "DeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "DeltaNodesCheck", + "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeltaNodesCheckHealthEvaluation", + "properties": { + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedApplicationHealth": { + "description": "Information about the health of an application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "DeployedApplicationHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "Name of the application deployed on the node whose health information is described by this object." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this application is deployed." + }, + "DeployedServicePackageHealthStates": { + "$ref": "#/definitions/DeployedServicePackageHealthStateList", + "description": "Deployed service package health states for the current deployed application as found in the health store." + } + } + } + ] + }, + "DeployedApplicationHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplication", + "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedApplicationHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where the application is deployed to." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "DeployedApplicationHealthState": { + "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "DeployedApplicationHealthState", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ] + }, + "DeployedApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "DeployedApplicationHealthStateChunk", + "properties": { + "NodeName": { + "type": "string", + "description": "The name of node where the application is deployed." + }, + "DeployedServicePackageHealthStateChunks": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList", + "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "DeployedApplicationHealthStateChunkList": { + "type": "object", + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunk" + }, + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedApplicationHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "DeployedServicePackageFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node." + } + } + }, + "DeployedApplicationInfo": { + "type": "object", + "description": "Information about application deployed on the node.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/DeployedApplicationStatus", + "description": "The status of the application deployed on the node. Following are the possible values." + }, + "WorkDirectory": { + "type": "string", + "description": "The work directory of the application on the node. The work directory can be used to store application data." + }, + "LogDirectory": { + "type": "string", + "description": "The log directory of the application on the node. The log directory can be used to store application logs." + }, + "TempDirectory": { + "type": "string", + "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "DeployedApplicationInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + }, + "description": "List of deployed application information." + }, + "DeployedApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplications", + "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedApplicationsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed applications of the application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedApplicationStatus": { + "type": "string", + "description": "The status of the application deployed on the node. Following are the possible values.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeployedApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Downloading", + "description": "Indicates that the package is downloading from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates that the package is activating. The value is 2." + }, + { + "value": "Active", + "description": "Indicates that the package is active. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates that the package is upgrading. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates that the package is deactivating. The value is 5." + } + ] + } + }, + "DeployedServicePackageHealth": { + "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "DeployedServicePackageHealth", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the service manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this service package is deployed." + } + } + } + ] + }, + "DeployedServicePackageHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackage", + "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "DeployedServicePackageHealthState": { + "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthState", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the manifest describing the service package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + } + ] + }, + "DeployedServicePackageHealthStateChunk": { + "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthStateChunk", + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + } + ] + }, + "DeployedServicePackageHealthStateChunkList": { + "type": "object", + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunk" + }, + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedServicePackageHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.", + "properties": { + "ServiceManifestNameFilter": { + "type": "string", + "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "ServicePackageActivationIdFilter": { + "type": "string", + "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "DeployedServicePackageHealthStateList": { + "description": "List of health states for a service package deployed on a Service Fabric node.", + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthState" + } + }, + "DeployedServicePackagesHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackages", + "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedServicePackagesHealthEvaluation", + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed service packages of the deployed application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedServiceReplicaInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that hosts this replica." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "Address": { + "type": "string", + "description": "The last address returned by the replica in Open or ChangeRole." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostProcessId": { + "type": "string", + "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel." + } + } + }, + "DeployedServiceReplicaInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + "description": "List of deployed service replica information." + }, + "DeployedStatefulServiceReplicaInfo": { + "description": "Information about a stateful service replica deployed on a node.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaInfo", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReconfigurationInformation": { + "$ref": "#/definitions/ReconfigurationInformation", + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time." + } + } + } + ] + }, + "DeployedStatelessServiceInstanceInfo": { + "description": "Information about a stateless service instance deployed on a node.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "EntityHealth": { + "type": "object", + "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy." + }, + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + }, + "description": "The list of health events reported on the entity." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager." + }, + "HealthStatistics": { + "$ref": "#/definitions/HealthStatistics", + "description": "Shows the health statistics for all children types of the queried entity." + } + } + }, + "EntityHealthState": { + "type": "object", + "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunk": { + "type": "object", + "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunkList": { + "type": "object", + "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.", + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description." + } + } + }, + "Epoch": { + "type": "object", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", + "properties": { + "ConfigurationVersion": { + "type": "string", + "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." + }, + "DataLossVersion": { + "type": "string", + "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + } + } + }, + "BackupEpoch": { + "type": "object", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", + "properties": { + "ConfigurationNumber": { + "type": "string", + "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." + }, + "DataLossNumber": { + "type": "string", + "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + } + } + }, + "EventHealthEvaluation": { + "x-ms-discriminator-value": "Event", + "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "EventHealthEvaluation", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity." + }, + "UnhealthyEvent": { + "$ref": "#/definitions/HealthEvent", + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager." + } + } + } + ] + }, + "EventList": { + "description": "A list of FabricEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FabricEvent" + } + }, + "FabricCodeVersionInfo": { + "type": "object", + "description": "Information about a Service Fabric code version.", + "properties": { + "CodeVersion": { + "description": "The product version of Service Fabric.", + "type": "string" + } + } + }, + "FabricCodeVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricCodeVersionInfo" + }, + "description": "List of all Service Fabric code versions." + }, + "FabricConfigVersionInfo": { + "type": "object", + "description": "Information about a Service Fabric config version.", + "properties": { + "ConfigVersion": { + "description": "The config version of Service Fabric.", + "type": "string" + } + } + }, + "FabricConfigVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricConfigVersionInfo" + }, + "description": "List of all Service Fabric config versions." + }, + "FabricError": { + "type": "object", + "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.", + "properties": { + "Error": { + "$ref": "#/definitions/FabricErrorError", + "description": "Error object containing error code and error message." + } + }, + "required": [ + "Error" + ] + }, + "FabricErrorError": { + "type": "object", + "description": "Error object containing error code and error message.", + "properties": { + "Code": { + "$ref": "#/definitions/FabricErrorCodes", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" + }, + "Message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "Code" + ] + }, + "FabricErrorCodes": { + "type": "string", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", + "enum": [ + "FABRIC_E_INVALID_PARTITION_KEY", + "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", + "FABRIC_E_INVALID_ADDRESS", + "FABRIC_E_APPLICATION_NOT_UPGRADING", + "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_FABRIC_NOT_UPGRADING", + "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_INVALID_CONFIGURATION", + "FABRIC_E_INVALID_NAME_URI", + "FABRIC_E_PATH_TOO_LONG", + "FABRIC_E_KEY_TOO_LARGE", + "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED", + "FABRIC_E_INVALID_ATOMIC_GROUP", + "FABRIC_E_VALUE_EMPTY", + "FABRIC_E_NODE_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_NOT_FOUND", + "FABRIC_E_APPLICATION_NOT_FOUND", + "FABRIC_E_SERVICE_TYPE_NOT_FOUND", + "FABRIC_E_SERVICE_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND", + "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND", + "FABRIC_E_PARTITION_NOT_FOUND", + "FABRIC_E_REPLICA_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST", + "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND", + "FABRIC_E_DIRECTORY_NOT_FOUND", + "FABRIC_E_FABRIC_VERSION_NOT_FOUND", + "FABRIC_E_FILE_NOT_FOUND", + "FABRIC_E_NAME_DOES_NOT_EXIST", + "FABRIC_E_PROPERTY_DOES_NOT_EXIST", + "FABRIC_E_ENUMERATION_COMPLETED", + "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND", + "FABRIC_E_KEY_NOT_FOUND", + "FABRIC_E_HEALTH_ENTITY_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS", + "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS", + "FABRIC_E_SERVICE_ALREADY_EXISTS", + "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_TYPE_IN_USE", + "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS", + "FABRIC_E_FABRIC_VERSION_IN_USE", + "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS", + "FABRIC_E_NAME_ALREADY_EXISTS", + "FABRIC_E_NAME_NOT_EMPTY", + "FABRIC_E_PROPERTY_CHECK_FAILED", + "FABRIC_E_SERVICE_METADATA_MISMATCH", + "FABRIC_E_SERVICE_TYPE_MISMATCH", + "FABRIC_E_HEALTH_STALE_REPORT", + "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED", + "FABRIC_E_NODE_HAS_NOT_STOPPED_YET", + "FABRIC_E_INSTANCE_ID_MISMATCH", + "FABRIC_E_VALUE_TOO_LARGE", + "FABRIC_E_NO_WRITE_QUORUM", + "FABRIC_E_NOT_PRIMARY", + "FABRIC_E_NOT_READY", + "FABRIC_E_RECONFIGURATION_PENDING", + "FABRIC_E_SERVICE_OFFLINE", + "E_ABORT", + "FABRIC_E_COMMUNICATION_ERROR", + "FABRIC_E_OPERATION_NOT_COMPLETE", + "FABRIC_E_TIMEOUT", + "FABRIC_E_NODE_IS_UP", + "E_FAIL", + "FABRIC_E_BACKUP_IS_ENABLED", + "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH", + "FABRIC_E_INVALID_FOR_STATELESS_SERVICES", + "FABRIC_E_BACKUP_NOT_ENABLED", + "FABRIC_E_BACKUP_POLICY_NOT_EXISTING", + "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING", + "FABRIC_E_BACKUP_IN_PROGRESS", + "FABRIC_E_RESTORE_IN_PROGRESS", + "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING", + "FABRIC_E_INVALID_SERVICE_SCALING_POLICY", + "E_INVALIDARG" + ], + "x-ms-enum": { + "name": "FabricErrorCodes", + "modelAsString": true, + "values": [ + { + "value": "FABRIC_E_INVALID_PARTITION_KEY" + }, + { + "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_ADDRESS" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_FABRIC_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_CONFIGURATION" + }, + { + "value": "FABRIC_E_INVALID_NAME_URI" + }, + { + "value": "FABRIC_E_PATH_TOO_LONG" + }, + { + "value": "FABRIC_E_KEY_TOO_LARGE" + }, + { + "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" + }, + { + "value": "FABRIC_E_INVALID_ATOMIC_GROUP" + }, + { + "value": "FABRIC_E_VALUE_EMPTY" + }, + { + "value": "FABRIC_E_NODE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" + }, + { + "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" + }, + { + "value": "FABRIC_E_PARTITION_NOT_FOUND" + }, + { + "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" + }, + { + "value": "FABRIC_E_DIRECTORY_NOT_FOUND" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND" + }, + { + "value": "FABRIC_E_FILE_NOT_FOUND" + }, + { + "value": "FABRIC_E_NAME_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_ENUMERATION_COMPLETED" + }, + { + "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" + }, + { + "value": "FABRIC_E_KEY_NOT_FOUND" + }, + { + "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_SERVICE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_NAME_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_NAME_NOT_EMPTY" + }, + { + "value": "FABRIC_E_PROPERTY_CHECK_FAILED" + }, + { + "value": "FABRIC_E_SERVICE_METADATA_MISMATCH" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_MISMATCH" + }, + { + "value": "FABRIC_E_HEALTH_STALE_REPORT" + }, + { + "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" + }, + { + "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" + }, + { + "value": "FABRIC_E_INSTANCE_ID_MISMATCH" + }, + { + "value": "FABRIC_E_VALUE_TOO_LARGE" + }, + { + "value": "FABRIC_E_NO_WRITE_QUORUM" + }, + { + "value": "FABRIC_E_NOT_PRIMARY" + }, + { + "value": "FABRIC_E_NOT_READY" + }, + { + "value": "FABRIC_E_RECONFIGURATION_PENDING" + }, + { + "value": "FABRIC_E_SERVICE_OFFLINE" + }, + { + "value": "E_ABORT" + }, + { + "value": "FABRIC_E_COMMUNICATION_ERROR" + }, + { + "value": "FABRIC_E_OPERATION_NOT_COMPLETE" + }, + { + "value": "FABRIC_E_TIMEOUT" + }, + { + "value": "FABRIC_E_NODE_IS_UP" + }, + { + "value": "E_FAIL" + }, + { + "value": "FABRIC_E_BACKUP_IS_ENABLED" + }, + { + "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" + }, + { + "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" + }, + { + "value": "FABRIC_E_BACKUP_NOT_ENABLED" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" + }, + { + "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" + }, + { + "value": "FABRIC_E_BACKUP_IN_PROGRESS" + }, + { + "value": "FABRIC_E_RESTORE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" + }, + { + "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" + }, + { + "value": "E_INVALIDARG" + } + ] + } + }, + "FabricEvent": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the base for all Fabric Events.", + "properties": { + "Kind": { + "$ref": "#/definitions/FabricEventKind", + "description": "The kind of FabricEvent." + }, + "EventInstanceId": { + "type": "string", + "format": "uuid", + "description": "The identifier for the FabricEvent instance." + }, + "TimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time event was logged." + }, + "HasCorrelatedEvents": { + "type": "boolean", + "description": "Shows there is existing related events available." + } + }, + "required": [ + "Kind", + "EventInstanceId", + "TimeStamp" + ] + }, + "FabricEventKind": { + "type": "string", + "description": "The kind of FabricEvent.", + "enum": [ + "ClusterEvent", + "ContainerInstanceEvent", + "NodeEvent", + "ApplicationEvent", + "ServiceEvent", + "PartitionEvent", + "ReplicaEvent", + "PartitionAnalysisEvent", + "ApplicationCreated", + "ApplicationDeleted", + "ApplicationHealthReportCreated", + "ApplicationHealthReportExpired", + "ApplicationUpgradeComplete", + "ApplicationUpgradeDomainComplete", + "ApplicationUpgradeRollbackComplete", + "ApplicationUpgradeRollbackStart", + "ApplicationUpgradeStart", + "DeployedApplicationHealthReportCreated", + "DeployedApplicationHealthReportExpired", + "ProcessDeactivated", + "ContainerDeactivated", + "NodeAborted", + "NodeAborting", + "NodeAdded", + "NodeClose", + "NodeClosing", + "NodeDeactivateComplete", + "NodeDeactivateStart", + "NodeDown", + "NodeHealthReportCreated", + "NodeHealthReportExpired", + "NodeOpenedSuccess", + "NodeOpenFailed", + "NodeOpening", + "NodeRemoved", + "NodeUp", + "PartitionHealthReportCreated", + "PartitionHealthReportExpired", + "PartitionReconfigurationCompleted", + "PartitionPrimaryMoveAnalysis", + "ServiceCreated", + "ServiceDeleted", + "ServiceHealthReportCreated", + "ServiceHealthReportExpired", + "DeployedServiceHealthReportCreated", + "DeployedServiceHealthReportExpired", + "StatefulReplicaHealthReportCreated", + "StatefulReplicaHealthReportExpired", + "StatelessReplicaHealthReportCreated", + "StatelessReplicaHealthReportExpired", + "ClusterHealthReportCreated", + "ClusterHealthReportExpired", + "ClusterUpgradeComplete", + "ClusterUpgradeDomainComplete", + "ClusterUpgradeRollbackComplete", + "ClusterUpgradeRollbackStart", + "ClusterUpgradeStart", + "ChaosStopped", + "ChaosStarted", + "ChaosRestartNodeFaultCompleted", + "ChaosRestartCodePackageFaultScheduled", + "ChaosRestartCodePackageFaultCompleted", + "ChaosRemoveReplicaFaultScheduled", + "ChaosRemoveReplicaFaultCompleted", + "ChaosMoveSecondaryFaultScheduled", + "ChaosMovePrimaryFaultScheduled", + "ChaosRestartReplicaFaultScheduled", + "ChaosRestartNodeFaultScheduled" + ], + "x-ms-enum": { + "name": "FabricEventKind", + "modelAsString": true, + "values": [ + { + "value": "ClusterEvent" + }, + { + "value": "ContainerInstanceEvent" + }, + { + "value": "NodeEvent" + }, + { + "value": "ApplicationEvent" + }, + { + "value": "ServiceEvent" + }, + { + "value": "PartitionEvent" + }, + { + "value": "ReplicaEvent" + }, + { + "value": "PartitionAnalysisEvent" + }, + { + "value": "ApplicationCreated" + }, + { + "value": "ApplicationDeleted" + }, + { + "value": "ApplicationHealthReportCreated" + }, + { + "value": "ApplicationHealthReportExpired" + }, + { + "value": "ApplicationUpgradeComplete" + }, + { + "value": "ApplicationUpgradeDomainComplete" + }, + { + "value": "ApplicationUpgradeRollbackComplete" + }, + { + "value": "ApplicationUpgradeRollbackStart" + }, + { + "value": "ApplicationUpgradeStart" + }, + { + "value": "DeployedApplicationHealthReportCreated" + }, + { + "value": "DeployedApplicationHealthReportExpired" + }, + { + "value": "ProcessDeactivated" + }, + { + "value": "ContainerDeactivated" + }, + { + "value": "NodeAborted" + }, + { + "value": "NodeAborting" + }, + { + "value": "NodeAdded" + }, + { + "value": "NodeClose" + }, + { + "value": "NodeClosing" + }, + { + "value": "NodeDeactivateComplete" + }, + { + "value": "NodeDeactivateStart" + }, + { + "value": "NodeDown" + }, + { + "value": "NodeHealthReportCreated" + }, + { + "value": "NodeHealthReportExpired" + }, + { + "value": "NodeOpenedSuccess" + }, + { + "value": "NodeOpenFailed" + }, + { + "value": "NodeOpening" + }, + { + "value": "NodeRemoved" + }, + { + "value": "NodeUp" + }, + { + "value": "PartitionHealthReportCreated" + }, + { + "value": "PartitionHealthReportExpired" + }, + { + "value": "PartitionReconfigurationCompleted" + }, + { + "value": "PartitionPrimaryMoveAnalysis" + }, + { + "value": "ServiceCreated" + }, + { + "value": "ServiceDeleted" + }, + { + "value": "ServiceHealthReportCreated" + }, + { + "value": "ServiceHealthReportExpired" + }, + { + "value": "DeployedServiceHealthReportCreated" + }, + { + "value": "DeployedServiceHealthReportExpired" + }, + { + "value": "StatefulReplicaHealthReportCreated" + }, + { + "value": "StatefulReplicaHealthReportExpired" + }, + { + "value": "StatelessReplicaHealthReportCreated" + }, + { + "value": "StatelessReplicaHealthReportExpired" + }, + { + "value": "ClusterHealthReportCreated" + }, + { + "value": "ClusterHealthReportExpired" + }, + { + "value": "ClusterUpgradeComplete" + }, + { + "value": "ClusterUpgradeDomainComplete" + }, + { + "value": "ClusterUpgradeRollbackComplete" + }, + { + "value": "ClusterUpgradeRollbackStart" + }, + { + "value": "ClusterUpgradeStart" + }, + { + "value": "ChaosStopped" + }, + { + "value": "ChaosStarted" + }, + { + "value": "ChaosRestartNodeFaultCompleted" + }, + { + "value": "ChaosRestartCodePackageFaultScheduled" + }, + { + "value": "ChaosRestartCodePackageFaultCompleted" + }, + { + "value": "ChaosRemoveReplicaFaultScheduled" + }, + { + "value": "ChaosRemoveReplicaFaultCompleted" + }, + { + "value": "ChaosMoveSecondaryFaultScheduled" + }, + { + "value": "ChaosMovePrimaryFaultScheduled" + }, + { + "value": "ChaosRestartReplicaFaultScheduled" + }, + { + "value": "ChaosRestartNodeFaultScheduled" + } + ] + } + }, + "ClusterConfigurationUpgradeStatusInfo": { + "type": "object", + "description": "Information about a standalone cluster configuration upgrade status.", + "properties": { + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "ProgressStatus": { + "type": "integer", + "description": "The cluster manifest version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "Details": { + "type": "string", + "description": "The cluster upgrade status details." + } + } + }, + "FailureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Invalid", + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rollback", + "description": "The upgrade will start rolling back automatically. The value is 1" + }, + { + "value": "Manual", + "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2" + } + ] + } + }, + "FailureReason": { + "type": "string", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed.", + "enum": [ + "None", + "Interrupted", + "HealthCheck", + "UpgradeDomainTimeout", + "OverallUpgradeTimeout" + ], + "x-ms-enum": { + "name": "FailureReason", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Interrupted", + "description": "There was an external request to rollback the upgrade. The value is 1" + }, + { + "value": "HealthCheck", + "description": "The upgrade failed due to health policy violations. The value is 2" + }, + { + "value": "UpgradeDomainTimeout", + "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3" + }, + { + "value": "OverallUpgradeTimeout", + "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4" + } + ] + } + }, + "FailureUpgradeDomainProgressInfo": { + "type": "object", + "description": "Information about the upgrade domain progress at the time of upgrade failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H10M0S" + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "0" + }, + "HealthEvaluation": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.", + "properties": { + "Kind": { + "$ref": "#/definitions/HealthEvaluationKind", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values." + }, + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "Description": { + "type": "string", + "description": "Description of the health evaluation, which represents a summary of the evaluation process." + } + }, + "required": [ + "Kind" + ] + }, + "HealthEvaluationKind": { + "type": "string", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.", + "enum": [ + "Invalid", + "Event", + "Replicas", + "Partitions", + "DeployedServicePackages", + "DeployedApplications", + "Services", + "Nodes", + "Applications", + "SystemApplication", + "UpgradeDomainDeployedApplications", + "UpgradeDomainNodes", + "Replica", + "Partition", + "DeployedServicePackage", + "DeployedApplication", + "Service", + "Node", + "Application", + "DeltaNodesCheck", + "UpgradeDomainDeltaNodesCheck", + "ApplicationTypeApplications" + ], + "x-ms-enum": { + "name": "HealthEvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the health evaluation is invalid. The value is zero." + }, + { + "value": "Event", + "description": "Indicates that the health evaluation is for a health event. The value is 1." + }, + { + "value": "Replicas", + "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2." + }, + { + "value": "Partitions", + "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3." + }, + { + "value": "DeployedServicePackages", + "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4." + }, + { + "value": "DeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5." + }, + { + "value": "Services", + "description": "Indicates that the health evaluation is for services of an application. The value is 6." + }, + { + "value": "Nodes", + "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7." + }, + { + "value": "Applications", + "description": "Indicates that the health evaluation is for the cluster applications. The value is 8." + }, + { + "value": "SystemApplication", + "description": "Indicates that the health evaluation is for the system application. The value is 9." + }, + { + "value": "UpgradeDomainDeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10." + }, + { + "value": "UpgradeDomainNodes", + "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11." + }, + { + "value": "Replica", + "description": "Indicates that the health evaluation is for a replica. The value is 13." + }, + { + "value": "Partition", + "description": "Indicates that the health evaluation is for a partition. The value is 14." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates that the health evaluation is for a deployed service package. The value is 16." + }, + { + "value": "DeployedApplication", + "description": "Indicates that the health evaluation is for a deployed application. The value is 17." + }, + { + "value": "Service", + "description": "Indicates that the health evaluation is for a service. The value is 15." + }, + { + "value": "Node", + "description": "Indicates that the health evaluation is for a node. The value is 12." + }, + { + "value": "Application", + "description": "Indicates that the health evaluation is for an application. The value is 18." + }, + { + "value": "DeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19." + }, + { + "value": "UpgradeDomainDeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20." + }, + { + "value": "ApplicationTypeApplications", + "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21." + } + ] + } + }, + "HealthEvaluationWrapper": { + "type": "object", + "description": "Wrapper object for health evaluation.", + "properties": { + "HealthEvaluation": { + "$ref": "#/definitions/HealthEvaluation", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity." + } + } + }, + "HealthEvent": { + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.", + "allOf": [ + { + "$ref": "#/definitions/HealthInformation" + }, + { + "type": "object", + "description": "HealthEvent", + "properties": { + "IsExpired": { + "type": "boolean", + "description": "Returns true if the health event is expired, otherwise false." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was sent by the source." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was last modified by the health store." + }, + "LastOkTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time." + }, + "LastWarningTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time." + }, + "LastErrorTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time." + } + } + } + ] + }, + "HealthInformation": { + "type": "object", + "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.", + "required": [ + "SourceId", + "Property", + "HealthState" + ], + "properties": { + "SourceId": { + "type": "string", + "description": "The source name which identifies the client/watchdog/system component which generated the health information." + }, + "Property": { + "type": "string", + "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "TimeToLiveInMilliSeconds": { + "type": "string", + "format": "duration", + "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value." + }, + "Description": { + "type": "string", + "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string." + }, + "SequenceNumber": { + "type": "string", + "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, is the reporter has issues (eg. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state." + } + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "Int64RangePartitionInformation": { + "description": "Describes the partition information for the integer range that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Int64Range", + "properties": { + "LowKey": { + "type": "string", + "description": "Specifies the minimum key value handled by this partition." + }, + "HighKey": { + "type": "string", + "description": "Specifies the maximum key value handled by this partition." + } + } + }, + "MonitoringPolicyDescription": { + "type": "object", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode.", + "properties": { + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + } + }, + "NamedPartitionInformation": { + "description": "Describes the partition information for the name as a string that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Named", + "properties": { + "Name": { + "type": "string", + "description": "Name of the partition." + } + } + }, + "NextUpgradeDomain": { + "type": "string", + "description": "The name of the next upgrade domain to be processed." + }, + "NodeDeactivationInfo": { + "type": "object", + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.", + "properties": { + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + }, + "NodeDeactivationStatus": { + "$ref": "#/definitions/NodeDeactivationStatus", + "description": "The status of node deactivation operation. Following are the possible values." + }, + "NodeDeactivationTask": { + "$ref": "#/definitions/NodeDeactivationTaskList", + "description": "List of tasks representing the deactivation operation on the node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeDeactivationIntent": { + "type": "string", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it.", + "enum": [ + "Invalid", + "Pause", + "Restart", + "RemoveData", + "RemoveNode" + ], + "x-ms-enum": { + "name": "NodeDeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3." + }, + { + "value": "RemoveNode", + "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4." + } + ] + } + }, + "NodeDeactivationStatus": { + "type": "string", + "description": "The status of node deactivation operation. Following are the possible values.", + "enum": [ + "None", + "SafetyCheckInProgress", + "SafetyCheckComplete", + "Completed" + ], + "x-ms-enum": { + "name": "NodeDeactivationStatus", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No status is associated with the task. The value is zero." + }, + { + "value": "SafetyCheckInProgress", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1." + }, + { + "value": "SafetyCheckComplete", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2." + }, + { + "value": "Completed", + "description": "The task is completed. The value is 3." + } + ] + } + }, + "NodeDeactivationTask": { + "type": "object", + "description": "The task representing the deactivation operation on the node.", + "properties": { + "NodeDeactivationTaskId": { + "$ref": "#/definitions/NodeDeactivationTaskId", + "description": "Identity of the task related to deactivation operation on the node." + }, + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + } + } + }, + "NodeDeactivationTaskId": { + "type": "object", + "description": "Identity of the task related to deactivation operation on the node.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the task id." + }, + "NodeDeactivationTaskType": { + "$ref": "#/definitions/NodeDeactivationTaskType", + "description": "The type of the task that performed the node deactivation. Following are the possible values." + } + } + }, + "NodeDeactivationTaskList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeDeactivationTask" + }, + "description": "List of tasks representing the deactivation operation on the node." + }, + "NodeDeactivationTaskType": { + "type": "string", + "description": "The type of the task that performed the node deactivation. Following are the possible values.", + "enum": [ + "Invalid", + "Infrastructure", + "Repair", + "Client" + ], + "x-ms-enum": { + "name": "NodeDeactivationTaskType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Infrastructure", + "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1." + }, + { + "value": "Repair", + "description": "Specifies the task that was created by the Repair Manager service. The value is 2." + }, + { + "value": "Client", + "description": "Specifies that the task was created by using the public API. The value is 3." + } + ] + } + }, + "NodeEvent": { + "description": "Represents the base for all Node Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "NodeEvent", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + }, + "required": [ + "NodeName" + ] + } + ], + "x-ms-discriminator-value": "NodeEvent" + }, + "NodeEventList": { + "description": "A list of NodeEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeEvent" + } + }, + "NodeHealth": { + "description": "Information about the health of a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "NodeHealth", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node whose health information is described by this object." + } + } + } + ] + }, + "NodeHealthEvaluation": { + "x-ms-discriminator-value": "Node", + "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "NodeHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "NodeHealthState": { + "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "NodeHealthState", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + } + } + } + ] + }, + "NodeHealthStateChunk": { + "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "NodeHealthStateChunk", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + } + } + ] + }, + "NodeHealthStateChunkList": { + "type": "object", + "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + }, + { + "type": "object", + "description": "NodeHealthStateChunkList", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateChunk" + }, + "description": "The list of node health state chunks that respect the input filters in the chunk query." + } + } + } + ] + }, + "NodeHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "NodeId": { + "type": "object", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the node Id. This is a 128 bit integer." + } + } + }, + "NodeIdList": { + "description": "A list of NodeIds.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeId" + } + }, + "NodeInfo": { + "type": "object", + "description": "Information about a node in Service Fabric cluster.", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "The IP address or fully qualified domain name of the node." + }, + "Type": { + "type": "string", + "description": "The type of the node." + }, + "CodeVersion": { + "type": "string", + "description": "The version of Service Fabric binaries that the node is running." + }, + "ConfigVersion": { + "type": "string", + "description": "The version of Service Fabric cluster manifest that the node is using." + }, + "NodeStatus": { + "$ref": "#/definitions/NodeStatus", + "description": "The status of the node." + }, + "NodeUpTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster." + }, + "UpgradeDomain": { + "type": "string", + "description": "The upgrade domain of the node." + }, + "FaultDomain": { + "type": "string", + "description": "The fault domain of the node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + }, + "InstanceId": { + "type": "string", + "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts." + }, + "NodeDeactivationInfo": { + "$ref": "#/definitions/NodeDeactivationInfo", + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated." + }, + "IsStopped": { + "type": "boolean", + "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false." + }, + "NodeDownTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down." + }, + "NodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time." + }, + "NodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time." + } + } + }, + "NodeLoadInfo": { + "type": "object", + "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node for which the load information is provided by this object." + }, + "NodeLoadMetricInformation": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeLoadMetricInformation" + }, + "description": "List that contains metrics and their load information on this node." + } + } + }, + "NodeLoadMetricInformation": { + "type": "object", + "description": "Represents data structure that contains load information for a certain metric on a node.", + "properties": { + "Name": { + "type": "string", + "description": "Name of the metric for which this load information is provided." + }, + "NodeCapacity": { + "type": "string", + "description": "Total capacity on the node for this metric." + }, + "NodeLoad": { + "type": "string", + "description": "Current load on the node for this metric." + }, + "NodeRemainingCapacity": { + "type": "string", + "description": "The remaining capacity on the node for this metric." + }, + "IsCapacityViolation": { + "type": "boolean", + "description": "Indicates if there is a capacity violation for this metric on the node." + }, + "NodeBufferedCapacity": { + "type": "string", + "description": "The value that indicates the reserved capacity for this metric on the node." + }, + "NodeRemainingBufferedCapacity": { + "type": "string", + "description": "The remaining reserved capacity for this metric on the node." + } + } + }, + "NodeName": { + "type": "string", + "description": "The name of a Service Fabric node." + }, + "NodeType": { + "type": "string", + "description": "The type name of a Service Fabric node.\nPlease refer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-nodetypes) for more details." + }, + "NodesHealthEvaluation": { + "x-ms-discriminator-value": "Nodes", + "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "NodesHealthEvaluation", + "properties": { + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "NodeStatus": { + "type": "string", + "description": "The status of the node.", + "enum": [ + "Invalid", + "Up", + "Down", + "Enabling", + "Disabling", + "Disabled", + "Unknown", + "Removed" + ], + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Up", + "description": "Indicates the node is up. The value is 1." + }, + { + "value": "Down", + "description": "Indicates the node is down. The value is 2." + }, + { + "value": "Enabling", + "description": "Indicates the node is in process of being enabled. The value is 3." + }, + { + "value": "Disabling", + "description": "Indicates the node is in the process of being disabled. The value is 4." + }, + { + "value": "Disabled", + "description": "Indicates the node is disabled. The value is 5." + }, + { + "value": "Unknown", + "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6." + }, + { + "value": "Removed", + "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7." + } + ] + } + }, + "NodeUpgradePhase": { + "type": "string", + "description": "The state of the upgrading node.", + "enum": [ + "Invalid", + "PreUpgradeSafetyCheck", + "Upgrading", + "PostUpgradeSafetyCheck" + ], + "x-ms-enum": { + "name": "NodeUpgradePhase", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PreUpgradeSafetyCheck", + "description": "The upgrade has not started yet due to pending safety checks. The value is 1" + }, + { + "value": "Upgrading", + "description": "The upgrade is in progress. The value is 2" + }, + { + "value": "PostUpgradeSafetyCheck", + "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3" + } + ] + } + }, + "NodeUpgradeProgressInfo": { + "type": "object", + "description": "Information about the upgrading node and its status", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UpgradePhase": { + "$ref": "#/definitions/NodeUpgradePhase", + "description": "The state of the upgrading node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeUpgradeProgressInfoList": { + "type": "array", + "description": "List of upgrading nodes and their statuses", + "items": { + "$ref": "#/definitions/NodeUpgradeProgressInfo" + } + }, + "PagedApplicationInfoList": { + "type": "object", + "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application information.", + "items": { + "$ref": "#/definitions/ApplicationInfo" + } + } + } + }, + "PagedDeployedApplicationInfoList": { + "type": "object", + "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of deployed application information.", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + } + } + }, + "PagedNodeInfoList": { + "type": "object", + "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of node information.", + "items": { + "$ref": "#/definitions/NodeInfo" + } + } + } + }, + "PagedServicePartitionInfoList": { + "type": "object", + "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service partition information.", + "items": { + "$ref": "#/definitions/ServicePartitionInfo" + } + } + } + }, + "PagedReplicaInfoList": { + "type": "object", + "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of replica information.", + "items": { + "$ref": "#/definitions/ReplicaInfo" + } + } + } + }, + "PagedServiceInfoList": { + "type": "object", + "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service information.", + "items": { + "$ref": "#/definitions/ServiceInfo" + } + } + } + }, + "PartitionAnalysisEvent": { + "description": "Represents the base for all Partition Analysis Events.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "description": "PartitionAnalysisEvent", + "properties": { + "Metadata": { + "$ref": "#/definitions/AnalysisEventMetadata", + "description": "Metadata about an Analysis Event." + } + }, + "required": [ + "Metadata" + ] + } + ], + "x-ms-discriminator-value": "PartitionAnalysisEvent" + }, + "PartitionEvent": { + "description": "Represents the base for all Partition Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "PartitionEvent", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "PartitionId" + ] + } + ], + "x-ms-discriminator-value": "PartitionEvent" + }, + "PartitionEventList": { + "description": "A list of PartitionEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PartitionEvent" + } + }, + "PartitionHealth": { + "description": "Information about the health of a Service Fabric partition.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "PartitionHealth", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "ID of the partition whose health information is described by this object." + }, + "ReplicaHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthState" + }, + "description": "The list of replica health states associated with the partition." + } + } + } + ] + }, + "PartitionHealthEvaluation": { + "x-ms-discriminator-value": "Partition", + "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "PartitionHealthEvaluation", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "PartitionHealthState": { + "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "PartitionHealthState", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health state is described by this object." + } + } + } + ] + }, + "PartitionHealthStateChunk": { + "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "PartitionHealthStateChunk", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The Id of the partition." + }, + "ReplicaHealthStateChunks": { + "$ref": "#/definitions/ReplicaHealthStateChunkList", + "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "PartitionHealthStateChunkList": { + "type": "object", + "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateChunk" + }, + "description": "The list of partition health state chunks that respect the input filters in the chunk query." + } + } + }, + "PartitionHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.", + "properties": { + "PartitionIdFilter": { + "type": "string", + "format": "uuid", + "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ReplicaFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateFilter" + }, + "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id." + } + } + }, + "PartitionId": { + "type": "string", + "format": "uuid", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "PartitionInformation": { + "type": "object", + "discriminator": "ServicePartitionKind", + "description": "Information about the partition identity, partitioning scheme and keys supported by it.", + "required": [ + "ServicePartitionKind" + ], + "properties": { + "ServicePartitionKind": { + "$ref": "#/definitions/ServicePartitionKind", + "description": "The kind of partitioning scheme used to partition the service." + }, + "Id": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "ProvisionFabricDescription": { + "type": "object", + "description": "Describes the parameters for provisioning a cluster.", + "properties": { + "CodeFilePath": { + "type": "string", + "description": "The cluster code package file path." + }, + "ClusterManifestFilePath": { + "type": "string", + "description": "The cluster manifest file path." + } + } + }, + "ProvisionApplicationTypeKind": { + "type": "string", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.", + "enum": [ + "Invalid", + "ImageStorePath", + "ExternalStore" + ], + "x-ms-enum": { + "name": "ProvisionApplicationTypeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero." + }, + { + "value": "ImageStorePath", + "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1." + }, + { + "value": "ExternalStore", + "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2." + } + ] + } + }, + "ProvisionApplicationTypeDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.", + "properties": { + "Kind": { + "$ref": "#/definitions/ProvisionApplicationTypeKind", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision." + }, + "Async": { + "type": "boolean", + "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true." + } + }, + "required": [ + "Kind", + "Async" + ] + }, + "ProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.", + "required": [ + "ApplicationTypeBuildPath" + ], + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + }, + { + "type": "object", + "description": "ProvisionApplicationTypeDescription", + "properties": { + "ApplicationTypeBuildPath": { + "description": "The relative path for the application package in the image store specified during the prior upload operation.", + "type": "string" + }, + "ApplicationPackageCleanupPolicy": { + "$ref": "#/definitions/ApplicationPackageCleanupPolicy", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision." + } + } + } + ], + "x-ms-discriminator-value": "ImageStorePath" + }, + "ExternalStoreProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + }, + { + "type": "object", + "description": "ExternalStoreProvisionApplicationTypeDescription", + "properties": { + "ApplicationPackageDownloadUri": { + "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.", + "type": "string" + }, + "ApplicationTypeName": { + "description": "The application type name represents the name of the application type found in the application manifest.", + "type": "string" + }, + "ApplicationTypeVersion": { + "description": "The application type version represents the version of the application type found in the application manifest.", + "type": "string" + } + } + } + ], + "x-ms-discriminator-value": "ExternalStore", + "required": [ + "ApplicationPackageDownloadUri", + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + }, + "UnprovisionFabricDescription": { + "type": "object", + "description": "Describes the parameters for unprovisioning a cluster.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code package version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster manifest version." + } + } + }, + "ResumeClusterUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for resuming a cluster upgrade.", + "properties": { + "UpgradeDomain": { + "type": "string", + "description": "The next upgrade domain for this cluster upgrade." + } + }, + "required": [ + "UpgradeDomain" + ] + }, + "StartClusterUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for starting a cluster upgrade.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "UpdateClusterUpgradeDescription": { + "description": "Parameters for updating a cluster upgrade.", + "properties": { + "UpgradeKind": { + "$ref": "#/definitions/UpgradeType", + "description": "The type of upgrade out of the following possible values." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "SafetyCheckKind": { + "type": "string", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.", + "enum": [ + "Invalid", + "EnsureSeedNodeQuorum", + "EnsurePartitionQuorum", + "WaitForPrimaryPlacement", + "WaitForPrimarySwap", + "WaitForReconfiguration", + "WaitForInbuildReplica", + "EnsureAvailability" + ], + "x-ms-enum": { + "name": "SafetyCheckKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "EnsureSeedNodeQuorum", + "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1." + }, + { + "value": "EnsurePartitionQuorum", + "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2." + }, + { + "value": "WaitForPrimaryPlacement", + "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3." + }, + { + "value": "WaitForPrimarySwap", + "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4." + }, + { + "value": "WaitForReconfiguration", + "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5." + }, + { + "value": "WaitForInbuildReplica", + "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6." + }, + { + "value": "EnsureAvailability", + "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7." + } + ] + } + }, + "SafetyCheck": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "Kind": { + "$ref": "#/definitions/SafetyCheckKind", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionSafetyCheck": { + "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + }, + { + "type": "object", + "description": "PartitionSafetyCheck", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition which is undergoing the safety check." + } + } + } + ] + }, + "EnsureAvailabilitySafetyCheck": { + "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "EnsureAvailabilitySafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureAvailability" + }, + "EnsurePartitionQurumSafetyCheck": { + "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "EnsurePartitionQurumSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsurePartitionQuorum" + }, + "SeedNodeSafetyCheck": { + "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + }, + { + "type": "object", + "description": "SeedNodeSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureSeedNodeQuorum" + }, + "PartitionsHealthEvaluation": { + "x-ms-discriminator-value": "Partitions", + "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "PartitionsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of partitions of the service from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ReplicaEvent": { + "description": "Represents the base for all Replica Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ReplicaEvent", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId_Integer", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + }, + "required": [ + "PartitionId", + "ReplicaId" + ] + } + ], + "x-ms-discriminator-value": "ReplicaEvent" + }, + "ReplicaEventList": { + "description": "A list of ReplicaEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaEvent" + } + }, + "ReplicaHealth": { + "discriminator": "ServiceKind", + "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ReplicaHealth", + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which this replica belongs." + } + }, + "required": [ + "ServiceKind" + ] + } + ] + }, + "ReplicaHealthEvaluation": { + "x-ms-discriminator-value": "Replica", + "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ReplicaHealthEvaluation", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which the replica belongs." + }, + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "ReplicaHealthState": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "description": "Represents a base class for stateful service replica or stateless service instance health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ReplicaHealthState", + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The ID of the partition to which this replica belongs." + } + } + } + ] + }, + "ReplicaHealthStateChunk": { + "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ReplicaHealthStateChunk", + "properties": { + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + } + } + } + ] + }, + "ReplicaHealthStateChunkList": { + "type": "object", + "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateChunk" + }, + "description": "The list of replica health state chunks that respect the input filters in the chunk query." + } + } + }, + "ReplicaHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.", + "properties": { + "ReplicaOrInstanceIdFilter": { + "type": "string", + "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "ReplicaId": { + "type": "string", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaId_Integer": { + "type": "integer", + "format": "int64", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaOrInstanceId": { + "type": "string", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "ReplicaInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Address": { + "type": "string", + "description": "The address the replica is listening on." + }, + "LastInBuildDurationInSeconds": { + "type": "string", + "description": "The last in build duration of the replica in seconds." + } + } + }, + "ReplicaRole": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Primary", + "IdleSecondary", + "ActiveSecondary" + ], + "x-ms-enum": { + "name": "ReplicaRole", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the initial role that a replica is created in. The value is zero." + }, + { + "value": "None", + "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1" + }, + { + "value": "Primary", + "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2." + }, + { + "value": "IdleSecondary", + "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3." + }, + { + "value": "ActiveSecondary", + "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4." + } + ] + } + }, + "ReplicasHealthEvaluation": { + "x-ms-discriminator-value": "Replicas", + "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ReplicasHealthEvaluation", + "properties": { + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of replicas in the partition from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ReplicaStatus": { + "type": "string", + "description": "The status of a replica of a service.", + "enum": [ + "Invalid", + "InBuild", + "Standby", + "Ready", + "Down", + "Dropped" + ], + "x-ms-enum": { + "name": "ReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InBuild", + "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1." + }, + { + "value": "Standby", + "description": "The replica is in standby. The value is 2." + }, + { + "value": "Ready", + "description": "The replica is ready. The value is 3." + }, + { + "value": "Down", + "description": "The replica is down. The value is 4." + }, + { + "value": "Dropped", + "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5." + } + ] + } + }, + "RestartNodeDescription": { + "description": "Describes the parameters to restart a Service Fabric node.", + "properties": { + "NodeInstanceId": { + "type": "string", + "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.", + "default": "0" + }, + "CreateFabricDump": { + "type": "string", + "description": "Specify True to create a dump of the fabric node process. This is case sensitive.", + "enum": [ + "False", + "True" + ], + "default": "False", + "x-ms-enum": { + "name": "CreateFabricDump", + "modelAsString": true, + "values": [ + { + "value": "False" + }, + { + "value": "True" + } + ] + } + } + }, + "required": [ + "NodeInstanceId" + ] + }, + "SafetyCheckInfoList": { + "type": "array", + "description": "List of pending safety checks", + "items": { + "$ref": "#/definitions/SafetyCheckWrapper" + } + }, + "SafetyCheckWrapper": { + "type": "object", + "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "SafetyCheck": { + "$ref": "#/definitions/SafetyCheck", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state." + } + } + }, + "ServiceEvent": { + "description": "Represents the base for all Service Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ServiceEvent", + "properties": { + "ServiceId": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + } + }, + "required": [ + "ServiceId" + ] + } + ], + "x-ms-discriminator-value": "ServiceEvent" + }, + "ServiceEventList": { + "description": "A list of ServiceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEvent" + } + }, + "ServiceFromTemplateDescription": { + "type": "object", + "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.", + "required": [ + "ApplicationName", + "ServiceName", + "ServiceTypeName" + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data for the newly created service instance." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + } + } + }, + "ServiceHealthEvaluation": { + "x-ms-discriminator-value": "Service", + "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ServiceHealthEvaluation", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "ServiceHealthState": { + "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ServiceHealthState", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health state is represented by this object." + } + } + } + ] + }, + "ServiceHealthStateChunk": { + "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ServiceHealthStateChunk", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health state chunk is provided in this object." + }, + "PartitionHealthStateChunks": { + "$ref": "#/definitions/PartitionHealthStateChunkList", + "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "ServiceHealthStateChunkList": { + "type": "object", + "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateChunk" + }, + "description": "The list of service health state chunks that respect the input filters in the chunk query." + } + } + }, + "ServiceHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.", + "properties": { + "ServiceNameFilter": { + "type": "string", + "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "PartitionFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateFilter" + }, + "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID." + } + } + }, + "ServiceHealth": { + "description": "Information about the health of a Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ServiceHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health information is described by this object." + }, + "PartitionHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthState" + }, + "description": "The list of partition health states associated with the service." + } + } + } + ] + }, + "ServiceId": { + "type": "string", + "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "type": "string", + "description": "The name of the service manifest." + }, + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ManifestVersion": { + "description": "The version of the service manifest.", + "type": "string" + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ServiceStatus": { + "$ref": "#/definitions/ServiceStatus", + "description": "The status of the application." + }, + "IsServiceGroup": { + "description": "Whether the service is in a service group.", + "type": "boolean" + } + }, + "required": [ + "ServiceKind" + ] + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Invalid", + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ServiceNameInfo": { + "type": "object", + "description": "Information about the service name.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + }, + "ServicePackageActivationId": { + "type": "string", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "ServicePartitionInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a partition of a Service Fabric service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "PartitionStatus": { + "$ref": "#/definitions/ServicePartitionStatus", + "description": "The status of the service fabric service partition." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition identity, partitioning scheme and keys supported by it." + } + } + }, + "ServicePartitionKind": { + "type": "string", + "description": "The kind of partitioning scheme used to partition the service.", + "enum": [ + "Invalid", + "Singleton", + "Int64Range", + "Named" + ], + "x-ms-enum": { + "name": "ServicePartitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1." + }, + { + "value": "Int64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3." + } + ] + } + }, + "ServicePartitionStatus": { + "type": "string", + "description": "The status of the service fabric service partition.", + "enum": [ + "Invalid", + "Ready", + "NotReady", + "InQuorumLoss", + "Reconfiguring", + "Deleting" + ], + "x-ms-enum": { + "name": "ServicePartitionStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1." + }, + { + "value": "NotReady", + "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2." + }, + { + "value": "InQuorumLoss", + "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3." + }, + { + "value": "Reconfiguring", + "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the partition is being deleted. The value is 5." + } + ] + } + }, + "ServicePlacementInvalidDomainPolicyDescription": { + "x-ms-discriminator-value": "InvalidDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + } + ] + }, + "ServicePlacementNonPartiallyPlaceServicePolicyDescription": { + "x-ms-discriminator-value": "NonPartiallyPlaceService", + "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicyDescription" + } + ] + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "description": "The type of placement policy for a service fabric service. Following are the possible values." + } + } + }, + "ServicePlacementPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "List of service placement policy descriptions." + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicyDescription": { + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service�s primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequiredDomainPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequireDomainDistributionPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomainDistribution", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicesHealthEvaluation": { + "x-ms-discriminator-value": "Services", + "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ServicesHealthEvaluation", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type of the services." + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of services of the current service type in the application from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ServiceStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the service status is unknown. The value is zero." + }, + { + "value": "Active", + "description": "Indicates the service status is active. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the service is upgrading. The value is 2." + }, + { + "value": "Deleting", + "description": "Indicates the service is being deleted. The value is 3." + }, + { + "value": "Creating", + "description": "Indicates the service is being created. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5." + } + ] + } + }, + "ServiceTypeDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPolicyDescriptionList", + "description": "List of service placement policy descriptions." + }, + "Extensions": { + "$ref": "#/definitions/ServiceTypeExtensionDescriptionList", + "description": "List of service type extensions." + } + } + }, + "ServiceTypeExtensionDescription": { + "type": "object", + "description": "Describes extension of a service type defined in the service manifest.", + "properties": { + "Key": { + "type": "string", + "description": "The name of the extension." + }, + "Value": { + "type": "string", + "description": "The extension value." + } + } + }, + "ServiceTypeExtensionDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeExtensionDescription" + }, + "description": "List of service type extensions." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", + "default": 0 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" + }, + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation." + }, + "ServiceTypeHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ServiceTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the service type health policy map item. This is the name of the service type." + }, + "Value": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type." + } + } + }, + "ServiceTypeInfo": { + "type": "object", + "description": "Information about a service type that is defined in a service manifest of a provisioned application type.", + "properties": { + "ServiceTypeDescription": { + "$ref": "#/definitions/ServiceTypeDescription", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "ServiceManifestVersion": { + "type": "string", + "description": "The version of the service manifest in which this service type is defined." + }, + "IsServiceGroup": { + "type": "boolean", + "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false." + } + } + }, + "ServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeInfo" + }, + "description": "List of service type information." + }, + "ServiceTypeManifest": { + "type": "object", + "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "SingletonPartitionInformation": { + "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceInfo": { + "description": "Information about a stateful Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + }, + { + "type": "object", + "description": "StatefulService", + "properties": { + "HasPersistedState": { + "description": "Whether the service has persisted state.", + "type": "boolean" + } + } + } + ], + "x-ms-discriminator-value": "Stateful" + }, + "StatefulServicePartitionInfo": { + "description": "Information about a partition of a stateful Service Fabric service..", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + }, + { + "type": "object", + "description": "StatefulServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The minimum replica set size as a number." + }, + "LastQuorumLossDuration": { + "type": "string", + "format": "duration", + "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration." + }, + "CurrentConfigurationEpoch": { + "$ref": "#/definitions/Epoch", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica." + } + } + }, + "StatefulServiceReplicaHealth": { + "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealth", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatefulServiceReplicaHealthState": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealthState", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatefulServiceTypeDescription": { + "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + }, + { + "type": "object", + "description": "StatefulServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + } + } + }, + "StatelessServiceInfo": { + "description": "Information about a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + }, + { + "type": "object", + "description": "StatelessService" + } + ], + "x-ms-discriminator-value": "Stateless" + }, + "StatelessServiceInstanceHealth": { + "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealth", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "StatelessServiceInstanceHealthState": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealthState", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of the stateless service instance on the wire this field is called ReplicaId." + } + } + } + ] + }, + "StatelessServicePartitionInfo": { + "description": "Information about a partition of a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "format": "int64", + "description": "Number of instances of this partition." + } + } + }, + "StatelessServiceTypeDescription": { + "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + }, + { + "type": "object", + "description": "StatelessServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "UseImplicitHost": { + "type": "boolean", + "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise." + } + } + }, + "SystemApplicationHealthEvaluation": { + "x-ms-discriminator-value": "SystemApplication", + "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "SystemApplicationHealthEvaluation", + "properties": { + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "TargetApplicationName": { + "type": "string", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "type": "string", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "TargetDeploymentName": { + "type": "string", + "description": "The name of the target deployment." + }, + "UnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "UpgradeDomainDeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck", + "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "UpgradeDomainDeltaNodesCheckHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "UpgradeDomainInfo": { + "type": "object", + "description": "Information about an upgrade domain.", + "properties": { + "Name": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "State": { + "$ref": "#/definitions/UpgradeDomainState", + "description": "The state of the upgrade domain." + } + } + }, + "UpgradeDomainInfoList": { + "type": "array", + "description": "List of upgrade domains and their statuses.", + "items": { + "$ref": "#/definitions/UpgradeDomainInfo" + } + }, + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain" + }, + "UpgradeDomainNodesHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainNodes", + "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "UpgradeDomainNodesHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "UpgradeDomainState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "Pending", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "UpgradeDomainState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Pending", + "description": "The upgrade domain has not started upgrading yet. The value is 1" + }, + { + "value": "InProgress", + "description": "The upgrade domain is being upgraded but not complete yet. The value is 2" + }, + { + "value": "Completed", + "description": "The upgrade domain has completed upgrade. The value is 3" + } + ] + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeDuration": { + "type": "string", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "UpgradeKind": { + "type": "string", + "description": "The kind of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1" + } + ] + } + }, + "UpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.", + "enum": [ + "Invalid", + "UnmonitoredAuto", + "UnmonitoredManual", + "Monitored" + ], + "default": "UnmonitoredAuto", + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1" + }, + { + "value": "UnmonitoredManual", + "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2" + }, + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3" + } + ] + } + }, + "UpgradeType": { + "type": "string", + "description": "The type of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling", + "Rolling_ForceRestart" + ], + "x-ms-enum": { + "name": "UpgradeType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1." + }, + { + "value": "Rolling_ForceRestart", + "description": "The upgrade gets restarted by force. The value is 2." + } + ] + } + }, + "UpgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", + "default": 42949672925 + }, + "UpgradeState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "RollingBackInProgress", + "RollingBackCompleted", + "RollingForwardPending", + "RollingForwardInProgress", + "RollingForwardCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1" + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 2" + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4" + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5" + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6" + } + ] + } + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "WaitForInbuildReplicaSafetyCheck": { + "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForInbuildReplicaSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForInbuildReplica" + }, + "WaitForPrimaryPlacementSafetyCheck": { + "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForPrimaryPlacementSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimaryPlacement" + }, + "WaitForPrimarySwapSafetyCheck": { + "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForPrimarySwapSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimarySwap" + }, + "WaitForReconfigurationSafetyCheck": { + "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForReconfigurationSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForReconfiguration" + }, + "LoadMetricReport": { + "type": "object", + "description": "Represents the load metric report which contains the time metric was reported, its name and value.", + "properties": { + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the UTC time when the load was reported." + }, + "Name": { + "type": "string", + "description": "The name of the load metric." + }, + "Value": { + "type": "string", + "format": "int32", + "description": "The value of the load metric." + } + } + }, + "PartitionLoadInformation": { + "type": "object", + "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition." + }, + "PrimaryLoadMetricReports": { + "type": "array", + "description": "Array of load reports from the primary replica for this partition.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + }, + "SecondaryLoadMetricReports": { + "type": "array", + "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + } + } + }, + "StatefulServiceReplicaInfo": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + }, + { + "type": "object", + "description": "StatefulServiceReplicaInfo", + "properties": { + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatelessServiceInstanceInfo": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + }, + { + "type": "object", + "description": "StatelessServiceInstanceInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "ClusterFabricCodeVersionString": { + "type": "string", + "description": "The ServiceFabric code version of the cluster." + }, + "ClusterFabricConfigVersionString": { + "type": "string", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "ClusterUpgradeDescriptionObject": { + "type": "object", + "description": "Represents a ServiceFabric cluster upgrade", + "properties": { + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + } + } + }, + "ClusterUpgradeHealthPolicyObject": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.", + "properties": { + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.", + "maximum": 100, + "minimum": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.", + "maximum": 100, + "minimum": 0 + } + } + }, + "ClusterUpgradeProgressObject": { + "type": "object", + "description": "Information about a cluster upgrade.", + "properties": { + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ClusterUpgradeDescriptionObject", + "description": "Represents a ServiceFabric cluster upgrade" + }, + "UpgradeDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDurationString", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainDurationString", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "$ref": "#/definitions/UpgradeStartTimeUTCString", + "description": "The start time of the upgrade in UTC." + }, + "FailureTimestampUtc": { + "$ref": "#/definitions/UpgradeFailureTimeUTCString", + "description": "The failure time of the upgrade in UTC." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailedUpgradeDomainProgressObject", + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure." + } + } + }, + "ClusterConfigurationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for a standalone cluster configuration upgrade.", + "properties": { + "ClusterConfig": { + "type": "string", + "description": "The cluster configuration." + }, + "HealthCheckRetryTimeout": { + "type": "string", + "format": "duration", + "description": "The length of time between attempts to perform a health checks if the application or cluster is not healthy.", + "default": "PT0H0M0S" + }, + "HealthCheckWaitDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.", + "default": "PT0H0M0S" + }, + "HealthCheckStableDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time that the application or cluster must remain healthy.", + "default": "PT0H0M0S" + }, + "UpgradeDomainTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The timeout for the upgrade domain.", + "default": "PT0H0M0S" + }, + "UpgradeTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The upgrade timeout.", + "default": "PT0H0M0S" + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + } + }, + "required": [ + "ClusterConfig" + ] + }, + "DeltaHealthEvaluationBool": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "FailedUpgradeDomainProgressObject": { + "type": "object", + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "UpgradeDomainDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UpgradeDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeFailureTimeUTCString": { + "type": "string", + "description": "The failure time of the upgrade in UTC." + }, + "UpgradeStartTimeUTCString": { + "type": "string", + "description": "The start time of the upgrade in UTC." + }, + "UpgradeOrchestrationServiceState": { + "type": "object", + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "properties": { + "ServiceState": { + "type": "string", + "description": "The state of Service Fabric Upgrade Orchestration Service." + } + } + }, + "UpgradeOrchestrationServiceStateSummary": { + "type": "object", + "description": "Service state summary of Service Fabric Upgrade Orchestration Service.", + "properties": { + "CurrentCodeVersion": { + "type": "string", + "description": "The current code version of the cluster." + }, + "CurrentManifestVersion": { + "type": "string", + "description": "The current manifest version of the cluster." + }, + "TargetCodeVersion": { + "type": "string", + "description": "The target code version of the cluster." + }, + "TargetManifestVersion": { + "type": "string", + "description": "The target manifest version of the cluster." + }, + "PendingUpgradeType": { + "type": "string", + "description": "The type of the pending upgrade of the cluster." + } + } + }, + "ApplicationTypeImageStorePath": { + "description": "Path description for the application package in the image store specified during the prior copy operation.", + "required": [ + "ApplicationTypeBuildPath" + ], + "properties": { + "ApplicationTypeBuildPath": { + "type": "string", + "description": "The relative image store path to the application package." + } + } + }, + "UnprovisionApplicationTypeDescriptionInfo": { + "type": "object", + "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.", + "required": [ + "ApplicationTypeVersion" + ], + "properties": { + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Async": { + "type": "boolean", + "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend to set it to true for large application packages that were provisioned." + } + } + }, + "CodePackageName": { + "type": "string", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageEntryPointStatistics": { + "type": "object", + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "LastExitCode": { + "type": "string", + "description": "The last exit code of the entry point." + }, + "LastActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when Service Fabric attempted to run the entry point." + }, + "LastExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running." + }, + "LastSuccessfulActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point ran successfully." + }, + "LastSuccessfulExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running gracefully." + }, + "ActivationCount": { + "type": "string", + "description": "Number of times the entry point has run." + }, + "ActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to run." + }, + "ContinuousActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to run." + }, + "ExitCount": { + "type": "string", + "description": "Number of times the entry point finished running." + }, + "ExitFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to exit gracefully." + }, + "ContinuousExitFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to exit gracefully." + } + } + }, + "DeployedCodePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedCodePackageInfo" + }, + "description": "List of deployed code package information." + }, + "DeployedCodePackageInfo": { + "type": "object", + "description": "Information about code package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package." + }, + "Version": { + "type": "string", + "description": "The version of the code package specified in service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostType": { + "$ref": "#/definitions/HostType", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest." + }, + "HostIsolationMode": { + "$ref": "#/definitions/HostIsolationMode", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "RunFrequencyInterval": { + "type": "string", + "description": "The interval at which code package is run. This is used for periodic code package." + }, + "SetupEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "MainEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + } + } + }, + "DeploymentStatus": { + "type": "string", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of the application or service package is not known or invalid. The value is 0." + }, + { + "value": "Downloading", + "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates the application or service package is being activated. The value is 2." + }, + { + "value": "Active", + "description": "Indicates the application or service package is active the node. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates the application or service package is being upgraded. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates the application or service package is being deactivated. The value is 5." + } + ] + } + }, + "EntryPointStatus": { + "type": "string", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.", + "enum": [ + "Invalid", + "Pending", + "Starting", + "Started", + "Stopping", + "Stopped" + ], + "x-ms-enum": { + "name": "EntryPointStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of entry point is not known or invalid. The value is 0." + }, + { + "value": "Pending", + "description": "Indicates the entry point is scheduled to be started. The value is 1." + }, + { + "value": "Starting", + "description": "Indicates the entry point is being started. The value is 2." + }, + { + "value": "Started", + "description": "Indicates the entry point was started successfully and is running. The value is 3." + }, + { + "value": "Stopping", + "description": "Indicates the entry point is being stopped. The value is 4." + }, + { + "value": "Stopped", + "description": "Indicates the entry point is not running. The value is 5." + } + ] + } + }, + "CodePackageEntryPoint": { + "type": "object", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "EntryPointLocation": { + "type": "string", + "description": "The location of entry point executable on the node." + }, + "ProcessId": { + "type": "string", + "description": "The process ID of the entry point." + }, + "RunAsUserName": { + "type": "string", + "description": "The user name under which entry point executable is run on the node." + }, + "CodePackageEntryPointStatistics": { + "$ref": "#/definitions/CodePackageEntryPointStatistics", + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "Status": { + "$ref": "#/definitions/EntryPointStatus", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node." + }, + "NextActivationTime": { + "type": "string", + "format": "date-time", + "description": "The time (in UTC) when the entry point executable will be run next." + }, + "InstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + } + } + }, + "Chaos": { + "type": "object", + "description": "Contains a description of Chaos.", + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "If Chaos is running, these are the parameters Chaos is running with." + }, + "Status": { + "$ref": "#/definitions/ChaosStatus", + "description": "Current status of the Chaos run." + }, + "ScheduleStatus": { + "$ref": "#/definitions/ChaosScheduleStatus", + "description": "Current status of the schedule." + } + } + }, + "ChaosStatus": { + "type": "string", + "description": "Current status of the Chaos run.", + "enum": [ + "Invalid", + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Running", + "description": "Indicates that Chaos is not stopped. The value is one." + }, + { + "value": "Stopped", + "description": "Indicates that Chaos is not scheduling further faults. The value is two." + } + ] + } + }, + "ChaosScheduleStatus": { + "type": "string", + "description": "Current status of the schedule.", + "enum": [ + "Invalid", + "Stopped", + "Active", + "Expired", + "Pending" + ], + "x-ms-enum": { + "name": "ChaosScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Stopped", + "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one." + }, + { + "value": "Active", + "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two." + }, + { + "value": "Expired", + "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three." + }, + { + "value": "Pending", + "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four." + } + ] + } + }, + "ChaosContextMap": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + }, + "ChaosContext": { + "type": "object", + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.", + "properties": { + "Map": { + "$ref": "#/definitions/ChaosContextMap", + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + } + } + }, + "ChaosParameters": { + "type": "object", + "description": "Defines all the parameters to configure a Chaos run.", + "properties": { + "TimeToRunInSeconds": { + "type": "string", + "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).", + "default": "4294967295" + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.", + "default": 60, + "minimum": 0, + "maximum": 4294967295 + }, + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults -- inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.", + "default": 1, + "minimum": 0, + "maximum": 4294967295 + }, + "EnableMoveReplicaFaults": { + "type": "boolean", + "description": "Enables or disables the move primary and move secondary faults.", + "default": true + }, + "WaitTimeBetweenFaultsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.", + "default": 20, + "minimum": 0, + "maximum": 4294967295 + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.", + "default": 30, + "minimum": 0, + "maximum": 4294967295 + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check." + }, + "Context": { + "$ref": "#/definitions/ChaosContext", + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run." + }, + "ChaosTargetFilter": { + "$ref": "#/definitions/ChaosTargetFilter", + "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification." + } + } + }, + "ChaosParametersDictionaryItem": { + "type": "object", + "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs." + }, + "Value": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + }, + "ChaosEvent": { + "type": "object", + "discriminator": "Kind", + "description": "Represents an event generated during a Chaos run.", + "properties": { + "Kind": { + "$ref": "#/definitions/ChaosEventKind", + "description": "The kind of Chaos event." + }, + "TimeStampUtc": { + "type": "string", + "description": "The UTC timestamp when this Chaos event was generated.", + "format": "date-time" + } + }, + "required": [ + "Kind", + "TimeStampUtc" + ] + }, + "ChaosEventWrapper": { + "type": "object", + "description": "Wrapper object for Chaos event.", + "properties": { + "ChaosEvent": { + "$ref": "#/definitions/ChaosEvent", + "description": "Represents an event generated during a Chaos run." + } + } + }, + "ChaosEventKind": { + "type": "string", + "description": "The kind of Chaos event.", + "enum": [ + "Invalid", + "Started", + "ExecutingFaults", + "Waiting", + "ValidationFailed", + "TestError", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosEventKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Started", + "description": "Indicates a Chaos event that gets generated when Chaos is started." + }, + { + "value": "ExecutingFaults", + "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings." + }, + { + "value": "Waiting", + "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish." + }, + { + "value": "ValidationFailed", + "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds." + }, + { + "value": "TestError", + "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted." + }, + { + "value": "Stopped", + "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up." + } + ] + } + }, + "ChaosEventsSegment": { + "type": "object", + "description": "Contains the list of Chaos events and the continuation token to get the next segment.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "History": { + "$ref": "#/definitions/ChaosEventHistory", + "description": "List of Chaos events that meet the user-supplied criteria." + } + } + }, + "ChaosScheduleDescription": { + "type": "object", + "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.", + "properties": { + "Version": { + "description": "The version number of the Schedule.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "Schedule": { + "$ref": "#/definitions/ChaosSchedule", + "description": "Defines the schedule used by Chaos." + } + } + }, + "ChaosSchedule": { + "type": "object", + "description": "Defines the schedule used by Chaos.", + "properties": { + "StartDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will start using this schedule.", + "default": "1601-01-01T00:00:00Z" + }, + "ExpiryDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will continue to use this schedule until.", + "default": "9999-12-31T23:59:59.999Z" + }, + "ChaosParametersDictionary": { + "type": "array", + "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.", + "items": { + "$ref": "#/definitions/ChaosParametersDictionaryItem" + } + }, + "Jobs": { + "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ChaosScheduleJob" + } + } + } + }, + "ChaosScheduleJob": { + "type": "object", + "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.", + "properties": { + "ChaosParameters": { + "type": "string", + "description": "A reference to which Chaos Parameters of the Chaos Schedule to use." + }, + "Days": { + "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek", + "description": "Defines the days of the week that a Chaos Schedule Job will run for." + }, + "Times": { + "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeRange" + } + } + } + }, + "ChaosScheduleJobActiveDaysOfWeek": { + "type": "object", + "description": "Defines the days of the week that a Chaos Schedule Job will run for.", + "properties": { + "Sunday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Sunday", + "default": false + }, + "Monday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Monday", + "default": false + }, + "Tuesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Tuesday", + "default": false + }, + "Wednesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Wednesday", + "default": false + }, + "Thursday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Thursday", + "default": false + }, + "Friday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Friday", + "default": false + }, + "Saturday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Saturday", + "default": false + } + } + }, + "TimeRange": { + "type": "object", + "description": "Defines a time range in a 24 hour day specified by a start and end time.", + "properties": { + "StartTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + }, + "EndTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + } + } + }, + "TimeOfDay": { + "type": "object", + "description": "Defines an hour and minute of the day specified in 24 hour time.", + "properties": { + "Hour": { + "type": "integer", + "format": "int32", + "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.", + "minimum": 0, + "maximum": 23 + }, + "Minute": { + "type": "integer", + "format": "int32", + "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.", + "minimum": 0, + "maximum": 59 + } + } + }, + "ExecutingFaultsChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.", + "x-ms-discriminator-value": "ExecutingFaults", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "ExecutingFaultsChaosEvent", + "properties": { + "Faults": { + "type": "array", + "description": "List of string description of the faults that Chaos decided to execute in an iteration.", + "items": { + "type": "string" + } + } + } + } + ] + }, + "StartedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is started.", + "x-ms-discriminator-value": "Started", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "StartedChaosEvent", + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + } + ] + }, + "StoppedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.", + "x-ms-discriminator-value": "Stopped", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "StoppedChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over." + } + } + } + ] + }, + "TestErrorChaosEvent": { + "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.", + "x-ms-discriminator-value": "TestError", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "TestErrorChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant." + } + } + } + ] + }, + "ValidationFailedChaosEvent": { + "description": "Chaos event corresponding to a failure during validation.", + "x-ms-discriminator-value": "ValidationFailed", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "ValidationFailedChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string." + } + } + } + ] + }, + "WaitingChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.", + "x-ms-discriminator-value": "Waiting", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "WaitingChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade." + } + } + } + ] + }, + "ChaosEventHistory": { + "type": "array", + "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.", + "items": { + "$ref": "#/definitions/ChaosEventWrapper" + } + }, + "ChaosTargetFilter": { + "type": "object", + "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.", + "properties": { + "NodeTypeInclusionList": { + "type": "array", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "ApplicationInclusionList": { + "type": "array", + "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/ApplicationName" + } + } + } + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "ApplicationCapacityDescription": { + "type": "object", + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application", + "properties": { + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", + "minimum": 0 + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", + "minimum": 0, + "default": 0 + }, + "ApplicationMetrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationDescription": { + "type": "object", + "description": "Describes a Service Fabric application.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "ParameterList": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationCapacity": { + "$ref": "#/definitions/ApplicationCapacityDescription", + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application" + } + }, + "required": [ + "Name", + "TypeName", + "TypeVersion" + ] + }, + "ApplicationMetricDescription": { + "type": "object", + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "MaximumCapacity": { + "type": "integer", + "format": "int64", + "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity." + }, + "ReservationCapacity": { + "type": "integer", + "format": "int64", + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric." + }, + "TotalApplicationCapacity": { + "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ComposeDeploymentStatus": { + "type": "string", + "description": "The status of the compose deployment.", + "enum": [ + "Invalid", + "Provisioning", + "Creating", + "Ready", + "Unprovisioning", + "Deleting", + "Failed", + "Upgrading" + ], + "x-ms-enum": { + "name": "ComposeDeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the compose deployment status is invalid. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the compose deployment is being provisioned in background. The value is 1." + }, + { + "value": "Creating", + "description": "Indicates that the compose deployment is being created in background. The value is 2." + }, + { + "value": "Ready", + "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the compose deployment is being deleted in background. The value is 5." + }, + { + "value": "Failed", + "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6." + }, + { + "value": "Upgrading", + "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7." + } + ] + } + }, + "ComposeDeploymentStatusInfo": { + "type": "object", + "description": "Information about a Service Fabric compose deployment.", + "properties": { + "Name": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "Status": { + "$ref": "#/definitions/ComposeDeploymentStatus", + "description": "The status of the compose deployment." + }, + "StatusDetails": { + "description": "The status details of compose deployment including failure message.", + "type": "string" + } + } + }, + "ComposeDeploymentUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent", + "UpgradeKind" + ] + }, + "ComposeDeploymentUpgradeProgressInfo": { + "type": "object", + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/TargetDeploymentName", + "description": "The name of the target deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "UpgradeState": { + "$ref": "#/definitions/ComposeDeploymentUpgradeState", + "description": "The state of the compose deployment upgrade." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDuration": { + "$ref": "#/definitions/UpgradeDuration", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "CurrentUpgradeDomainDuration": { + "$ref": "#/definitions/CurrentUpgradeDomainDuration", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "ApplicationUnhealthyEvaluations": { + "$ref": "#/definitions/ApplicationUnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "ApplicationUpgradeStatusDetails": { + "type": "string", + "description": "Additional details of application upgrade including failure message." + } + } + }, + "ComposeDeploymentUpgradeState": { + "type": "string", + "description": "The state of the compose deployment upgrade.", + "enum": [ + "Invalid", + "ProvisioningTarget", + "RollingForwardInProgress", + "RollingForwardPending", + "UnprovisioningCurrent", + "RollingForwardCompleted", + "RollingBackInProgress", + "UnprovisioningTarget", + "RollingBackCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "ComposeDeploymentUpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "ProvisioningTarget", + "description": "The upgrade is in the progress of provisioning target application type version. The value is 1." + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2." + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "UnprovisioningCurrent", + "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4." + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6." + }, + { + "value": "UnprovisioningTarget", + "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7." + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 8." + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9." + } + ] + } + }, + "PagedComposeDeploymentStatusInfoList": { + "type": "object", + "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of compose deployment status information.", + "items": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + } + } + }, + "CreateComposeDeploymentDescription": { + "type": "object", + "description": "Defines description for creating a Service Fabric compose deployment.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent" + ] + }, + "RegistryCredential": { + "type": "object", + "description": "Credential information to connect to container registry.", + "properties": { + "RegistryUserName": { + "type": "string", + "description": "The user name to connect to container registry." + }, + "RegistryPassword": { + "type": "string", + "description": "The password for supplied username to connect to container registry." + }, + "PasswordEncrypted": { + "type": "boolean", + "description": "Indicates that supplied container registry password is encrypted." + } + } + }, + "DeployedServicePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageInfo" + }, + "description": "List of deployed service package information." + }, + "DeployedServicePackageInfo": { + "type": "object", + "description": "Information about service package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service package as specified in the service manifest." + }, + "Version": { + "type": "string", + "description": "The version of the service package specified in service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeploymentName": { + "type": "string", + "description": "The name of the deployment." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Invalid", + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" + } + ] + } + }, + "ServiceCorrelationDescription": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "An invalid correlation scheme. Cannot be used. The value is zero." + }, + { + "value": "Affinity", + "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." + }, + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." + } + ] + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "SecondaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "DefaultLoad": { + "type": "integer", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServicePackageActivationMode": { + "type": "string", + "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero." + }, + { + "value": "ExclusiveProcess", + "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1." + } + ] + } + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "PartitionSchemeDescription": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "Count", + "Names" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "Names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." + } + } + }, + "SingletonPartitionSchemeDescription": { + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "UniformInt64RangePartitionSchemeDescription": { + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "Count", + "LowKey", + "HighKey" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "LowKey": { + "type": "string", + "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions." + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions." + } + } + }, + "ServiceDescription": { + "type": "object", + "discriminator": "ServiceKind", + "description": "A ServiceDescription contains all of the information necessary to create a service.", + "required": [ + "ServiceKind", + "ServiceName", + "ServiceTypeName", + "PartitionDescription" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created." + }, + "PartitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription", + "description": "The partition description as an object." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "ServiceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean", + "description": "Indicates if the DefaultMoveCost property is specified." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceDescription": { + "description": "Describes a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + }, + { + "type": "object", + "description": "StatefulServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "required": [ + "TargetReplicaSetSize", + "MinReplicaSetSize", + "HasPersistedState" + ], + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "Flags": { + "type": "integer", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceDescription": { + "description": "Describes a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + }, + { + "type": "object", + "description": "StatelessServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "InstanceCount" + ], + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ReplicatorQueueStatus": { + "type": "object", + "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.", + "properties": { + "QueueUtilizationPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full." + }, + "QueueMemorySize": { + "type": "string", + "description": "Represents the virtual memory consumed by the queue in bytes." + }, + "FirstSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue." + }, + "CompletedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state." + }, + "CommittedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary." + }, + "LastSequenceNumber": { + "type": "string", + "description": "Represents the latest sequence number of the operation that is available in the queue." + } + } + }, + "ReplicatorStatus": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + } + } + }, + "PrimaryReplicatorStatus": { + "x-ms-discriminator-value": "Primary", + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Status of the primary replicator.", + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the primary replicator." + }, + "RemoteReplicators": { + "$ref": "#/definitions/RemoteReplicatorStatusList", + "description": "The status of all the active and idle secondary replicators that the primary is aware of." + } + } + } + ] + }, + "SecondaryReplicatorStatus": { + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Represents a base class for secondary replicator status.", + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the secondary replicator." + }, + "LastReplicationOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received." + }, + "IsInBuild": { + "type": "boolean", + "description": "Value that indicates whether the replica is currently being built." + }, + "CopyQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the copy queue on the secondary replicator." + }, + "LastCopyOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received." + }, + "LastAcknowledgementSentTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent." + } + } + } + ] + }, + "SecondaryActiveReplicatorStatus": { + "x-ms-discriminator-value": "ActiveSecondary", + "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + }, + { + "type": "object" + } + ] + }, + "SecondaryIdleReplicatorStatus": { + "x-ms-discriminator-value": "IdleSecondary", + "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + }, + { + "type": "object" + } + ] + }, + "RemoteReplicatorStatus": { + "type": "object", + "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Represents the replica ID of the remote secondary replicator." + }, + "LastAcknowledgementProcessedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed." + }, + "LastReceivedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has received from the primary." + }, + "LastAppliedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has applied to its state." + }, + "IsInBuild": { + "type": "boolean", + "description": "A value that indicates whether the secondary replica is in the process of being built." + }, + "LastReceivedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations." + }, + "LastAppliedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete." + }, + "RemoteReplicatorAcknowledgementStatus": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus", + "description": "Represents the acknowledgment status for the remote secondary replicator." + } + } + }, + "RemoteReplicatorStatusList": { + "type": "array", + "items": { + "$ref": "#/definitions/RemoteReplicatorStatus" + }, + "description": "List of remote replicator status" + }, + "RemoteReplicatorAcknowledgementStatus": { + "type": "object", + "description": "Provides details about the remote replicators from the primary replicator's point of view.", + "properties": { + "ReplicationStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the replication stream data." + }, + "CopyStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the copy stream data." + } + } + }, + "RemoteReplicatorAcknowledgementDetail": { + "type": "object", + "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.", + "properties": { + "AverageReceiveDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to receive an operation." + }, + "AverageApplyDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk." + }, + "NotReceivedCount": { + "type": "string", + "description": "Represents the number of operations not yet received by a remote replicator." + }, + "ReceivedAndNotAppliedCount": { + "type": "string", + "description": "Represents the number of operations received and not yet applied by a remote replicator." + } + } + }, + "DeployedServiceReplicaDetailInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Full hierarchical name of the service in URI format starting with `fabric:`." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "CurrentServiceOperation": { + "$ref": "#/definitions/ServiceOperationName", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance." + }, + "CurrentServiceOperationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The start time of the current service operation in UTC format." + }, + "ReportedLoad": { + "$ref": "#/definitions/LoadMetricReportInfoList", + "description": "List of load reported by replica." + } + } + }, + "DeployedStatefulServiceReplicaDetailInfo": { + "description": "Information about a stateful replica running in a code package. Please note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaDetailInfo", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "CurrentReplicatorOperation": { + "$ref": "#/definitions/ReplicatorOperationName", + "description": "Specifies the operation currently being executed by the Replicator." + }, + "ReadStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "WriteStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "ReplicatorStatus": { + "$ref": "#/definitions/ReplicatorStatus", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc." + }, + "ReplicaStatus": { + "$ref": "#/definitions/KeyValueStoreReplicaStatus", + "description": "Key value store related information for the replica." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo", + "description": "Information about a stateful service replica deployed on a node." + } + } + } + ] + }, + "DeployedStatelessServiceInstanceDetailInfo": { + "description": "Information about a stateless instance running in a code package. Please note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceDetailInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo", + "description": "Information about a stateless service instance deployed on a node." + } + } + } + ] + }, + "FabricReplicaStatus": { + "type": "string", + "description": "Specifies the status of the replica.", + "enum": [ + "Invalid", + "Down", + "Up" + ], + "x-ms-enum": { + "name": "FabricReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Down", + "description": "Indicates that the replica is down." + }, + { + "value": "Up", + "description": "Indicates that the replica is up." + } + ] + } + }, + "LoadMetricReportInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadMetricReportInfo" + }, + "description": "List of load reported by replica." + }, + "LoadMetricReportInfo": { + "type": "object", + "description": "Information about load reported by replica.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "Value": { + "type": "integer", + "format": "int32", + "description": "The value of the load for the metric.." + }, + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC time when the load is reported." + } + } + }, + "PartitionAccessStatus": { + "type": "string", + "description": "Specifies the access status of the partition.", + "enum": [ + "Invalid", + "Granted", + "ReconfigurationPending", + "NotPrimary", + "NoWriteQuorum" + ], + "x-ms-enum": { + "name": "PartitionAccessStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Granted", + "description": "Indicates that the read or write operation access is granted and the operation is allowed." + }, + { + "value": "ReconfigurationPending", + "description": "Indicates that the client should try again later, because a reconfiguration is in progress." + }, + { + "value": "NotPrimary", + "description": "Indicates that this client request was received by a replica that is not a Primary replica." + }, + { + "value": "NoWriteQuorum", + "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted." + } + ] + } + }, + "ReplicatorOperationName": { + "type": "string", + "description": "Specifies the operation currently being executed by the Replicator.", + "enum": [ + "Invalid", + "None", + "Open", + "ChangeRole", + "UpdateEpoch", + "Close", + "Abort", + "OnDataLoss", + "WaitForCatchup", + "Build" + ], + "x-ms-enum": { + "name": "ReplicatorOperationName", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Default value if the replicator is not yet ready." + }, + { + "value": "None", + "description": "Replicator is not running any operation from Service Fabric perspective." + }, + { + "value": "Open", + "description": "Replicator is opening." + }, + { + "value": "ChangeRole", + "description": "Replicator is in the process of changing its role." + }, + { + "value": "UpdateEpoch", + "description": "Due to a change in the replica set, replicator is being updated with its Epoch." + }, + { + "value": "Close", + "description": "Replicator is closing." + }, + { + "value": "Abort", + "description": "Replicator is being aborted." + }, + { + "value": "OnDataLoss", + "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source." + }, + { + "value": "WaitForCatchup", + "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state." + }, + { + "value": "Build", + "description": "Replicator is in the process of building one or more replicas." + } + ] + } + }, + "ServiceOperationName": { + "type": "string", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.", + "enum": [ + "Unknown", + "None", + "Open", + "ChangeRole", + "Close", + "Abort" + ], + "x-ms-enum": { + "name": "ServiceOperationName", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Reserved for future use." + }, + { + "value": "None", + "description": "The service replica or instance is not going through any life-cycle changes." + }, + { + "value": "Open", + "description": "The service replica or instance is being opened." + }, + { + "value": "ChangeRole", + "description": "The service replica is changing roles." + }, + { + "value": "Close", + "description": "The service replica or instance is being closed." + }, + { + "value": "Abort", + "description": "The service replica or instance is being aborted." + } + ] + } + }, + "ReplicaKind": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Invalid", + "KeyValueStore" + ], + "x-ms-enum": { + "name": "ReplicaKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Represents an invalid replica kind. The value is zero." + }, + { + "value": "KeyValueStore", + "description": "Represents a key value store replica. The value is 1" + } + ] + } + }, + "ReplicaStatusBase": { + "type": "object", + "discriminator": "Kind", + "description": "Information about the replica.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaKind", + "description": "The role of a replica of a stateful service." + } + } + }, + "KeyValueStoreReplicaStatus": { + "description": "Key value store related information for the replica.", + "x-ms-discriminator-value": "KeyValueStore", + "allOf": [ + { + "$ref": "#/definitions/ReplicaStatusBase" + }, + { + "type": "object", + "description": "KeyValueStoreReplicaStatus", + "properties": { + "DatabaseRowCountEstimate": { + "type": "string", + "description": "Value indicating the estimated number of rows in the underlying database." + }, + "DatabaseLogicalSizeEstimate": { + "type": "string", + "description": "Value indicating the estimated size of the underlying database." + }, + "CopyNotificationCurrentKeyFilter": { + "type": "string", + "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback." + }, + "CopyNotificationCurrentProgress": { + "type": "string", + "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback." + }, + "StatusDetails": { + "type": "string", + "description": "Value indicating the current status details of the replica." + } + } + } + ] + }, + "ServiceUpdateDescription": { + "type": "object", + "discriminator": "ServiceKind", + "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "Flags": { + "type": "string", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceUpdateDescription": { + "description": "Describes an update for a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + }, + { + "type": "object", + "description": "StatefulServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "string", + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "string", + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceUpdateDescription": { + "description": "Describes an update for a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + }, + { + "type": "object", + "description": "StatelessServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ImageStoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileVersion": { + "type": "object", + "description": "Information about the version of image store file.", + "properties": { + "VersionNumber": { + "type": "string", + "description": "The current image store version number for the file is used in image store for checking whether it need to be updated." + }, + "EpochDataLossNumber": { + "type": "string", + "description": "The epoch data loss number of image store replica when this file entry was updated or created." + }, + "EpochConfigurationNumber": { + "type": "string", + "description": "The epoch configuration version number of the image store replica when this file entry was created or updated." + } + } + }, + "FileInfo": { + "type": "object", + "description": "Information about a image store file.", + "properties": { + "FileSize": { + "type": "string", + "description": "The size of file in bytes." + }, + "FileVersion": { + "$ref": "#/definitions/FileVersion", + "description": "Information about the version of image store file." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the image store file was last modified." + }, + "StoreRelativePath": { + "type": "string", + "description": "The file path relative to the image store root path." + } + } + }, + "FolderInfo": { + "type": "object", + "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.", + "properties": { + "StoreRelativePath": { + "$ref": "#/definitions/ImageStoreRelativePath", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileCount": { + "type": "string", + "description": "The number of files from within the image store folder." + } + } + }, + "ImageStoreContent": { + "type": "object", + "description": "Information about the image store content.", + "properties": { + "StoreFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/FileInfo" + }, + "description": "The list of image store file info objects represents files found under the given image store relative path." + }, + "StoreFolders": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderInfo" + }, + "description": "The list of image store folder info objects represents subfolders found under the given image store relative path." + } + } + }, + "ImageStoreCopyDescription": { + "type": "object", + "description": "Information about how to copy image store content from one image store relative path to another image store relative path.", + "required": [ + "RemoteSource", + "RemoteDestination" + ], + "properties": { + "RemoteSource": { + "type": "string", + "description": "The relative path of source image store content to be copied from." + }, + "RemoteDestination": { + "type": "string", + "description": "The relative path of destination image store content to be copied to." + }, + "SkipFiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of the file names to be skipped for copying." + }, + "CheckMarkFile": { + "type": "boolean", + "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped." + } + } + }, + "InstanceId": { + "type": "string", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "CodePackageInstanceId": { + "type": "string", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + }, + "HostIsolationMode": { + "type": "string", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.", + "enum": [ + "None", + "Process", + "HyperV" + ], + "x-ms-enum": { + "name": "HostIsolationMode", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0." + }, + { + "value": "Process", + "description": "This is the default isolation mode for a ContainerHost. The value is 1." + }, + { + "value": "HyperV", + "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2." + } + ] + } + }, + "HostType": { + "type": "string", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.", + "enum": [ + "Invalid", + "ExeHost", + "ContainerHost" + ], + "x-ms-enum": { + "name": "HostType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of host is not known or invalid. The value is 0." + }, + { + "value": "ExeHost", + "description": "Indicates the host is an executable. The value is 1." + }, + { + "value": "ContainerHost", + "description": "Indicates the host is a container. The value is 2." + } + ] + } + }, + "RestartDeployedCodePackageDescription": { + "type": "object", + "description": "Defines description for restarting a deployed code package on Service Fabric node.", + "required": [ + "ServiceManifestName", + "CodePackageName", + "CodePackageInstanceId" + ], + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageInstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package." + } + } + }, + "DeployedServiceTypeInfo": { + "type": "object", + "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.", + "properties": { + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that registered the service type." + }, + "Status": { + "$ref": "#/definitions/ServiceTypeRegistrationStatus", + "description": "The status of the service type registration on the node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeployedServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceTypeInfo" + }, + "description": "List of information about service type deployed on a node." + }, + "ServiceTypeRegistrationStatus": { + "type": "string", + "description": "The status of the service type registration on the node.", + "enum": [ + "Invalid", + "Disabled", + "Enabled", + "Registered" + ], + "x-ms-enum": { + "name": "ServiceTypeRegistrationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Disabled", + "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1." + }, + { + "value": "Enabled", + "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2." + }, + { + "value": "Registered", + "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3." + } + ] + } + }, + "ServiceEndpointRole": { + "type": "string", + "description": "The role of the replica where the endpoint is reported.", + "enum": [ + "Invalid", + "Stateless", + "StatefulPrimary", + "StatefulSecondary" + ], + "x-ms-enum": { + "name": "ServiceEndpointRole", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Indicates that the service endpoint is of a stateless service. The value is 1." + }, + { + "value": "StatefulPrimary", + "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2." + }, + { + "value": "StatefulSecondary", + "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3." + } + ] + } + }, + "ResolvedServiceEndpoint": { + "type": "object", + "description": "Endpoint of a resolved service partition.", + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceEndpointRole", + "description": "The role of the replica where the endpoint is reported." + }, + "Address": { + "type": "string", + "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener." + } + } + }, + "ResolvedServicePartition": { + "type": "object", + "description": "Information about a service partition and its associated endpoints.", + "required": [ + "Name", + "PartitionInformation", + "Endpoints", + "Version" + ], + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "A representation of the resolved partition." + }, + "Endpoints": { + "$ref": "#/definitions/ResolvedServiceEndpointList", + "description": "List of resolved service endpoints of a service partition." + }, + "Version": { + "type": "string", + "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter." + } + } + }, + "ResolvedServiceEndpointList": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolvedServiceEndpoint" + }, + "description": "List of resolved service endpoints of a service partition." + }, + "InvokeDataLossResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "InvokeQuorumLossResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "NodeResult": { + "type": "object", + "description": "Contains information about a node that was targeted by a user-induced operation.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "The node instance id." + } + } + }, + "NodeTransitionProgress": { + "type": "object", + "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "NodeTransitionResult": { + "$ref": "#/definitions/NodeTransitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "NodeTransitionResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "NodeResult": { + "$ref": "#/definitions/NodeResult", + "description": "Contains information about a node that was targeted by a user-induced operation." + } + } + }, + "OperationId": { + "type": "string", + "format": "uuid", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "OperationState": { + "type": "string", + "description": "The state of the operation.", + "enum": [ + "Invalid", + "Running", + "RollingBack", + "Completed", + "Faulted", + "Cancelled", + "ForceCancelled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "Running", + "description": "The operation is in progress." + }, + { + "value": "RollingBack", + "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command." + }, + { + "value": "Completed", + "description": "The operation has completed successfully and is no longer running." + }, + { + "value": "Faulted", + "description": "The operation has failed and is no longer running." + }, + { + "value": "Cancelled", + "description": "The operation was cancelled by the user using CancelOperation, and is no longer running." + }, + { + "value": "ForceCancelled", + "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details." + } + ] + } + }, + "OperationStatus": { + "type": "object", + "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.", + "properties": { + "OperationId": { + "$ref": "#/definitions/OperationId", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "Type": { + "$ref": "#/definitions/OperationType", + "description": "The type of the operation." + } + } + }, + "OperationStatusList": { + "type": "array", + "description": "A list of OperationStatus objects.", + "items": { + "$ref": "#/definitions/OperationStatus" + } + }, + "OperationType": { + "type": "string", + "description": "The type of the operation.", + "enum": [ + "Invalid", + "PartitionDataLoss", + "PartitionQuorumLoss", + "PartitionRestart", + "NodeTransition" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "PartitionDataLoss", + "description": "An operation started using the StartDataLoss API." + }, + { + "value": "PartitionQuorumLoss", + "description": "An operation started using the StartQuorumLoss API." + }, + { + "value": "PartitionRestart", + "description": "An operation started using the StartPartitionRestart API." + }, + { + "value": "NodeTransition", + "description": "An operation started using the StartNodeTransition API." + } + ] + } + }, + "PartitionDataLossProgress": { + "type": "object", + "description": "Information about a partition data loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeDataLossResult": { + "$ref": "#/definitions/InvokeDataLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionQuorumLossProgress": { + "type": "object", + "description": "Information about a partition quorum loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeQuorumLossResult": { + "$ref": "#/definitions/InvokeQuorumLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionRestartProgress": { + "type": "object", + "description": "Information about a partition restart user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "RestartPartitionResult": { + "$ref": "#/definitions/RestartPartitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "RestartPartitionResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "SelectedPartition": { + "type": "object", + "description": "This class returns information about the partition that the user-induced operation acted upon.", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service the partition belongs to." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "DeployServicePackageToNodeDescription": { + "type": "object", + "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.", + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest whose packages need to be downloaded." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "PackageSharingPolicy": { + "$ref": "#/definitions/PackageSharingPolicyInfoList", + "description": "List of package sharing policy information." + } + }, + "required": [ + "ServiceManifestName", + "ApplicationTypeName", + "ApplicationTypeVersion", + "NodeName" + ] + }, + "PackageSharingPolicyInfo": { + "type": "object", + "description": "Represents a policy for the package sharing.", + "properties": { + "SharedPackageName": { + "type": "string", + "description": "The name of code, configuration or data package that should be shared." + }, + "PackageSharingScope": { + "$ref": "#/definitions/PackageSharingPolicyScope", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation." + } + } + }, + "PackageSharingPolicyInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/PackageSharingPolicyInfo" + }, + "description": "List of package sharing policy information." + }, + "PackageSharingPolicyScope": { + "type": "string", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.", + "enum": [ + "None", + "All", + "Code", + "Config", + "Data" + ], + "x-ms-enum": { + "name": "PackageSharingPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No package sharing policy scope. The value is 0." + }, + { + "value": "All", + "description": "Share all code, config and data packages from corresponding service manifest. The value is 1." + }, + { + "value": "Code", + "description": "Share all code packages from corresponding service manifest. The value is 2." + }, + { + "value": "Config", + "description": "Share all config packages from corresponding service manifest. The value is 3." + }, + { + "value": "Data", + "description": "Share all data packages from corresponding service manifest. The value is 4." + } + ] + } + }, + "ResumeApplicationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain in which to resume the upgrade." + } + }, + "required": [ + "UpgradeDomainName" + ] + }, + "ApplicationUpgradeUpdateDescription": { + "type": "object", + "description": "Describes the parameters for updating an ongoing application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + } + }, + "required": [ + "Name", + "UpgradeKind" + ] + }, + "RollingUpgradeUpdateDescription": { + "type": "object", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster.", + "properties": { + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "ReplicaSetCheckTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + }, + "required": [ + "RollingUpgradeMode" + ] + }, + "NameDescription": { + "type": "object", + "description": "Describes a Service Fabric name.", + "properties": { + "Name": { + "$ref": "#/definitions/FabricName", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + } + }, + "required": [ + "Name" + ] + }, + "FabricName": { + "type": "string", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + }, + "PagedSubNameInfoList": { + "type": "object", + "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "SubNames": { + "type": "array", + "description": "List of the child names.", + "items": { + "$ref": "#/definitions/FabricName" + } + } + } + }, + "PropertyValueKind": { + "type": "string", + "description": "The kind of property, determined by the type of data. Following are the possible values.", + "enum": [ + "Invalid", + "Binary", + "Int64", + "Double", + "String", + "Guid" + ], + "x-ms-enum": { + "name": "PropertyValueKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Binary", + "description": "The data inside the property is a binary blob. The value is 1." + }, + { + "value": "Int64", + "description": "The data inside the property is an int64. The value is 2." + }, + { + "value": "Double", + "description": "The data inside the property is a double. The value is 3." + }, + { + "value": "String", + "description": "The data inside the property is a string. The value is 4." + }, + { + "value": "Guid", + "description": "The data inside the property is a guid. The value is 5." + } + ] + } + }, + "PropertyValue": { + "type": "object", + "discriminator": "Kind", + "description": "Describes a Service Fabric property value.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "BinaryPropertyValue": { + "description": "Describes a Service Fabric property value of type Binary.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "BinaryPropertyValue" + } + ], + "x-ms-discriminator-value": "Binary", + "required": [ + "Data" + ], + "properties": { + "Data": { + "$ref": "#/definitions/ByteArray", + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255." + } + } + }, + "Int64PropertyValue": { + "description": "Describes a Service Fabric property value of type Int64.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "Int64PropertyValue" + } + ], + "x-ms-discriminator-value": "Int64", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "DoublePropertyValue": { + "description": "Describes a Service Fabric property value of type Double.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "DoublePropertyValue" + } + ], + "x-ms-discriminator-value": "Double", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "number", + "format": "double", + "description": "The data of the property value." + } + } + }, + "StringPropertyValue": { + "description": "Describes a Service Fabric property value of type String.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "StringPropertyValue" + } + ], + "x-ms-discriminator-value": "String", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "GuidPropertyValue": { + "description": "Describes a Service Fabric property value of type Guid.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "GuidPropertyValue" + } + ], + "x-ms-discriminator-value": "Guid", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "format": "uuid", + "description": "The data of the property value." + } + } + }, + "PropertyInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Information about a Service Fabric property.", + "properties": { + "Name": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "Metadata": { + "$ref": "#/definitions/PropertyMetadata", + "description": "The metadata associated with a property, including the property's name." + } + }, + "required": [ + "Name", + "Metadata" + ] + }, + "PagedPropertyInfoList": { + "type": "object", + "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "Properties": { + "type": "array", + "description": "List of property information.", + "items": { + "$ref": "#/definitions/PropertyInfo" + } + } + } + }, + "PropertyDescription": { + "type": "object", + "description": "Description of a Service Fabric property.", + "properties": { + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + } + }, + "required": [ + "PropertyName", + "Value" + ] + }, + "PropertyName": { + "type": "string", + "description": "The name of the Service Fabric property." + }, + "PropertyMetadata": { + "type": "object", + "description": "The metadata associated with a property, including the property's name.", + "properties": { + "TypeId": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type id." + }, + "Parent": { + "$ref": "#/definitions/FabricName", + "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the namespace/table under which the property exists." + }, + "SizeInBytes": { + "type": "integer", + "description": "The length of the serialized property value." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated." + }, + "SequenceNumber": { + "type": "string", + "description": "The version of the property. Every time a property is modified, its sequence number is increased." + } + } + }, + "PropertyCustomTypeId": { + "type": "string", + "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." + }, + "PropertyBatchDescriptionList": { + "type": "object", + "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.", + "properties": { + "Operations": { + "type": "array", + "items": { + "$ref": "#/definitions/PropertyBatchOperation" + }, + "description": "A list of the property batch operations to be executed." + } + } + }, + "PropertyBatchOperationKind": { + "type": "string", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.", + "enum": [ + "Invalid", + "Put", + "Get", + "CheckExists", + "CheckSequence", + "Delete", + "CheckValue" + ], + "x-ms-enum": { + "name": "PropertyBatchOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Put", + "description": "The operation will create or edit a property. The value is 1." + }, + { + "value": "Get", + "description": "The operation will get a property. The value is 2." + }, + { + "value": "CheckExists", + "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3." + }, + { + "value": "CheckSequence", + "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4." + }, + { + "value": "Delete", + "description": "The operation will delete a property. The value is 5." + }, + { + "value": "CheckValue", + "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7." + } + ] + } + }, + "PropertyBatchOperation": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the base type for property operations that can be put into a batch and submitted.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchOperationKind", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values." + }, + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + } + }, + "required": [ + "Kind", + "PropertyName" + ] + }, + "CheckExistsPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckExistsPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckExists", + "properties": { + "Exists": { + "type": "boolean", + "description": "Whether or not the property should exist for the operation to pass." + } + }, + "required": [ + "Exists" + ] + }, + "CheckSequencePropertyBatchOperation": { + "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckSequencePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckSequence", + "properties": { + "SequenceNumber": { + "type": "string", + "description": "The expected sequence number." + } + }, + "required": [ + "SequenceNumber" + ] + }, + "CheckValuePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckValuePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckValue", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "The expected property value." + } + }, + "required": [ + "Value" + ] + }, + "DeletePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "DeletePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "GetPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "GetPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Get", + "properties": { + "IncludeValue": { + "type": "boolean", + "default": false, + "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata." + } + } + }, + "PutPropertyBatchOperation": { + "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "PutPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Put", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type id. Using this property, the user is able to tag the type of the value of the property." + } + }, + "required": [ + "Value" + ] + }, + "PropertyBatchInfoKind": { + "type": "string", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.", + "enum": [ + "Invalid", + "Successful", + "Failed" + ], + "x-ms-enum": { + "name": "PropertyBatchInfoKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Successful", + "description": "The property batch succeeded." + }, + { + "value": "Failed", + "description": "The property batch failed." + } + ] + } + }, + "PropertyBatchInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Information about the results of a property batch.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchInfoKind", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "SuccessfulPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + }, + { + "type": "object", + "description": "SuccessfulPropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Successful", + "properties": { + "Properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PropertyInfo" + }, + "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map." + } + } + }, + "FailedPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + }, + { + "type": "object", + "description": "FailedPropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Failed", + "properties": { + "ErrorMessage": { + "type": "string", + "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch." + }, + "OperationIndex": { + "type": "integer", + "description": "The index of the unsuccessful operation in the property batch." + } + } + }, + "EntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Node", + "Partition", + "Service", + "Application", + "Replica", + "DeployedApplication", + "DeployedServicePackage", + "Cluster" + ], + "x-ms-enum": { + "name": "EntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Node", + "description": "Indicates the entity is a Service Fabric node. The value is 1." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition. The value is 2." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service. The value is 3." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application. The value is 4." + }, + { + "value": "Replica", + "description": "Indicates the entity is a Service Fabric replica. The value is 5." + }, + { + "value": "DeployedApplication", + "description": "Indicates the entity is a Service Fabric deployed application. The value is 6." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7." + }, + { + "value": "Cluster", + "description": "Indicates the entity is a Service Fabric cluster. The value is 8." + } + ] + } + }, + "HealthStateCount": { + "type": "object", + "description": "Represents information about how many health entities are in Ok, Warning and Error health state.", + "properties": { + "OkCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Ok.", + "minimum": 0 + }, + "WarningCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Warning.", + "minimum": 0 + }, + "ErrorCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Error.", + "minimum": 0 + } + } + }, + "EntityKindHealthStateCount": { + "type": "object", + "description": "Represents health state count for entities of the specified entity kind.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/EntityKind", + "description": "The entity kind for which health states are evaluated." + }, + "HealthStateCount": { + "$ref": "#/definitions/HealthStateCount", + "description": "The health state count for the entities of the specified kind." + } + } + }, + "HealthStatistics": { + "type": "object", + "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.", + "properties": { + "HealthStateCountList": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityKindHealthStateCount" + }, + "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state." + } + } + }, + "BackupPolicyDescription": { + "type": "object", + "description": "Describes a backup policy for configuring periodic backup.", + "required": [ + "Name", + "AutoRestoreOnDataLoss", + "Schedule", + "MaxIncrementalBackups", + "Storage" + ], + "properties": { + "Name": { + "type": "string", + "description": "The unique name identifying this backup policy." + }, + "AutoRestoreOnDataLoss": { + "type": "boolean", + "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event." + }, + "MaxIncrementalBackups": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit." + }, + "Schedule": { + "$ref": "#/definitions/BackupScheduleDescription", + "description": "Describes the backup schedule parameters." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the details of backup storage where to store the periodic backups." + } + } + }, + "PagedBackupPolicyDescriptionList": { + "type": "object", + "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "The list of backup policies information.", + "items": { + "$ref": "#/definitions/BackupPolicyDescription" + } + } + } + }, + "BackupStorageDescription": { + "type": "object", + "required": [ + "StorageKind" + ], + "discriminator": "StorageKind", + "properties": { + "StorageKind": { + "$ref": "#/definitions/BackupStorageKind", + "description": "The kind of backup storage, where backups are saved." + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name for this backup storage." + } + }, + "description": "Describes the parameters for the backup storage." + }, + "BackupStorageKind": { + "type": "string", + "description": "The kind of backup storage, where backups are saved.", + "enum": [ + "Invalid", + "FileShare", + "AzureBlobStore" + ], + "x-ms-enum": { + "name": "BackupStorageKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "FileShare", + "description": "Indicates file/ SMB share to be used as backup storage." + }, + { + "value": "AzureBlobStore", + "description": "Indicates Azure blob store to be used as backup storage." + } + ] + } + }, + "BackupScheduleDescription": { + "type": "object", + "description": "Describes the backup schedule parameters.", + "required": [ + "ScheduleKind" + ], + "discriminator": "ScheduleKind", + "properties": { + "ScheduleKind": { + "$ref": "#/definitions/BackupScheduleKind", + "description": "The kind of backup schedule, time based or frequency based." + } + } + }, + "BackupScheduleKind": { + "type": "string", + "description": "The kind of backup schedule, time based or frequency based.", + "enum": [ + "Invalid", + "TimeBased", + "FrequencyBased" + ], + "x-ms-enum": { + "name": "BackupScheduleKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "TimeBased", + "description": "Indicates a time-based backup schedule." + }, + { + "value": "FrequencyBased", + "description": "Indicates a frequency-based backup schedule." + } + ] + } + }, + "ApplicationBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Application backup configuration information.", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Service backup configuration info", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Service" + }, + "PagedBackupConfigurationInfoList": { + "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup configuration information.", + "items": { + "$ref": "#/definitions/BackupConfigurationInfo" + } + } + } + }, + "BackupPolicyScope": { + "type": "string", + "description": "Specifies the scope at which the backup policy is applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level." + }, + { + "value": "Service", + "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level." + }, + { + "value": "Application", + "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level." + } + ] + } + }, + "BackupSuspensionScope": { + "type": "string", + "description": "Specifies the scope at which the backup suspension was applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupSuspensionScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup suspension is applied at partition level." + }, + { + "value": "Service", + "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup." + }, + { + "value": "Application", + "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup." + } + ] + } + }, + "RestorePartitionDescription": { + "type": "object", + "description": "Specifies the parameters needed to trigger a restore of a specific partition.", + "required": [ + "BackupId", + "BackupLocation" + ], + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID." + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup relative to the backup storage specified/ configured." + }, + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Location of the backup from where the partition will be restored." + } + } + }, + "RestoreProgressInfo": { + "type": "object", + "description": "Describes the progress of a restore operation on a partition.", + "properties": { + "RestoreState": { + "$ref": "#/definitions/RestoreState", + "description": "Represents the current state of the partition restore operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "Timestamp when operation succeeded or failed." + }, + "RestoredEpoch": { + "$ref": "#/definitions/BackupEpoch", + "description": "Describes the epoch at which the partition is restored." + }, + "RestoredLsn": { + "type": "string", + "description": "Restored LSN." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing restore operation." + } + } + }, + "RestoreState": { + "type": "string", + "description": "Represents the current state of the partition restore operation.", + "enum": [ + "Invalid", + "Accepted", + "RestoreInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "RestoreState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Restore is yet to be triggered." + }, + { + "value": "RestoreInProgress", + "description": "Restore operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupPartitionDescription": { + "type": "object", + "description": "Describes the parameters for triggering partition's backup.", + "properties": { + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Specifies the details of the backup storage where to save the backup." + } + } + }, + "BackupInfo": { + "type": "object", + "description": "Represents a backup point which can be used to trigger a restore.", + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID ." + }, + "BackupChainId": { + "type": "string", + "format": "uuid", + "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups." + }, + "ApplicationName": { + "type": "string", + "description": "Name of the Service Fabric application this partition backup belongs to." + }, + "ServiceName": { + "type": "string", + "description": "Name of the Service Fabric service this partition backup belongs to." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition to which this backup belongs to" + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup, relative to the backup store." + }, + "BackupType": { + "$ref": "#/definitions/BackupType", + "description": "Describes the type of backup, whether its full or incremental." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/BackupEpoch", + "description": "Epoch of the last record in this backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "LSN of the last record in this backup." + }, + "CreationTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The date time when this backup was taken." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in getting backup point information." + } + } + }, + "PagedBackupInfoList": { + "type": "object", + "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup information.", + "items": { + "$ref": "#/definitions/BackupInfo" + } + } + } + }, + "BackupType": { + "type": "string", + "description": "Describes the type of backup, whether its full or incremental.", + "enum": [ + "Invalid", + "Full", + "Incremental" + ], + "x-ms-enum": { + "name": "BackupType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Full", + "description": "Indicates a full backup." + }, + { + "value": "Incremental", + "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups." + } + ] + } + }, + "AzureBlobBackupStorageDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "AzureBlobBackupStorageDescription" + } + ], + "x-ms-discriminator-value": "AzureBlobStore", + "required": [ + "ConnectionString", + "ContainerName" + ], + "properties": { + "ConnectionString": { + "type": "string", + "description": "The connection string to connect to the Azure blob store." + }, + "ContainerName": { + "type": "string", + "description": "The name of the container in the blob store to store and enumerate backups from." + } + }, + "description": "Describes the parameters for Azure blob store used for storing and enumerating backups." + }, + "FileShareBackupStorageDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "FileShareBackupStorageDescription" + } + ], + "x-ms-discriminator-value": "FileShare", + "required": [ + "Path" + ], + "description": "Describes the parameters for file share storage used for storing or enumerating backups.", + "properties": { + "Path": { + "type": "string", + "description": "UNC path of the file share where to store or enumerate backups from." + }, + "PrimaryUserName": { + "type": "string", + "description": "Primary user name to access the file share." + }, + "PrimaryPassword": { + "type": "string", + "description": "Primary password to access the share location." + }, + "SecondaryUserName": { + "type": "string", + "description": "Secondary user name to access the file share." + }, + "SecondaryPassword": { + "type": "string", + "description": "Secondary password to access the share location" + } + } + }, + "FrequencyBasedBackupScheduleDescription": { + "type": "object", + "description": "Describes the frequency based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "FrequencyBasedBackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "FrequencyBased", + "required": [ + "Interval" + ], + "properties": { + "Interval": { + "type": "string", + "format": "duration", + "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy." + } + } + }, + "TimeBasedBackupScheduleDescription": { + "type": "object", + "description": "Describes the time based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "TimeBasedBackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "TimeBased", + "required": [ + "ScheduleFrequencyType", + "RunTimes" + ], + "properties": { + "ScheduleFrequencyType": { + "$ref": "#/definitions/BackupScheduleFrequencyType", + "description": "Describes the frequency with which to run the time based backup schedule." + }, + "RunDays": { + "$ref": "#/definitions/DayOfWeekList", + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "RunTimes": { + "$ref": "#/definitions/TimeList", + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + } + } + }, + "BackupScheduleFrequencyType": { + "type": "string", + "description": "Describes the frequency with which to run the time based backup schedule.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "x-ms-enum": { + "name": "BackupScheduleFrequencyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Daily", + "description": "Indicates that the time based backup schedule is repeated at a daily frequency." + }, + { + "value": "Weekly", + "description": "Indicates that the time based backup schedule is repeated at a weekly frequency." + } + ] + } + }, + "TimeList": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + }, + "DayOfWeekList": { + "type": "array", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "DayOfWeek": { + "type": "string", + "description": "Describes the days in a week.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true, + "values": [ + { + "value": "Sunday", + "description": "Indicates the Day referred is Sunday." + }, + { + "value": "Monday", + "description": "Indicates the Day referred is Monday." + }, + { + "value": "Tuesday", + "description": "Indicates the Day referred is Tuesday." + }, + { + "value": "Wednesday", + "description": "Indicates the Day referred is Wednesday." + }, + { + "value": "Thursday", + "description": "Indicates the Day referred is Thursday." + }, + { + "value": "Friday", + "description": "Indicates the Day referred is Friday." + }, + { + "value": "Saturday", + "description": "Indicates the Day referred is Saturday." + } + ] + } + }, + "BackupProgressInfo": { + "type": "object", + "description": "Describes the progress of a partition's backup.", + "properties": { + "BackupState": { + "$ref": "#/definitions/BackupState", + "description": "Represents the current state of the partition backup operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "TimeStamp in UTC when operation succeeded or failed." + }, + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique ID of the newly created backup." + }, + "BackupLocation": { + "type": "string", + "description": "Location, relative to the backup store, of the newly created backup." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/BackupEpoch", + "description": "Specifies the epoch of the last record included in backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "The LSN of last record included in backup." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing backup operation." + } + } + }, + "BackupConfigurationInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the backup configuration information.", + "properties": { + "Kind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + }, + "PolicyName": { + "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.", + "type": "string" + }, + "PolicyInheritedFrom": { + "$ref": "#/definitions/BackupPolicyScope", + "description": "Specifies the scope at which the backup policy is applied." + }, + "SuspensionInfo": { + "$ref": "#/definitions/BackupSuspensionInfo", + "description": "Describes the backup suspension details." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionBackupConfigurationInfo": { + "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Partition backup configuration info", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + } + ], + "x-ms-discriminator-value": "Partition" + }, + "BackupState": { + "type": "string", + "description": "Represents the current state of the partition backup operation.", + "enum": [ + "Invalid", + "Accepted", + "BackupInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "BackupState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Backup is yet to be triggered." + }, + { + "value": "BackupInProgress", + "description": "Backup operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupEntity": { + "type": "object", + "discriminator": "EntityKind", + "description": "Describes the Service Fabric entity that is configured for backup.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + } + }, + "required": [ + "EntityKind" + ] + }, + "ApplicationBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric application which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ApplicationBackupEntity", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful service which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ServiceBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Service" + }, + "PartitionBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful partition which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "PartitionBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + } + ], + "x-ms-discriminator-value": "Partition" + }, + "EnableBackupDescription": { + "description": "Specifies the parameters needed to enable periodic backup.", + "required": [ + "BackupPolicyName" + ], + "properties": { + "BackupPolicyName": { + "type": "string", + "description": "Name of the backup policy to be used for enabling periodic backups." + } + } + }, + "PagedBackupEntityList": { + "type": "object", + "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup entity information.", + "items": { + "$ref": "#/definitions/BackupEntity" + } + } + } + }, + "BackupSuspensionInfo": { + "type": "object", + "description": "Describes the backup suspension details.", + "properties": { + "IsSuspended": { + "type": "boolean", + "description": "Indicates whether periodic backup is suspended at this level or not." + }, + "SuspensionInheritedFrom": { + "$ref": "#/definitions/BackupSuspensionScope", + "description": "Specifies the scope at which the backup suspension was applied." + } + } + }, + "BackupEntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupEntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application." + } + ] + } + }, + "GetBackupByStorageQueryDescription": { + "type": "object", + "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.", + "required": [ + "Storage", + "BackupEntity" + ], + "properties": { + "StartDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning." + }, + "EndDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end." + }, + "Latest": { + "type": "boolean", + "default": false, + "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore." + }, + "BackupEntity": { + "$ref": "#/definitions/BackupEntity", + "description": "Indicates the entity for which to enumerate backups." + } + } + }, + "NodeImpact": { + "type": "object", + "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "NodeName": { + "type": "string", + "description": "The name of the impacted node." + }, + "ImpactLevel": { + "type": "string", + "enum": [ + "Invalid", + "None", + "Restart", + "RemoveData", + "RemoveNode" + ], + "description": "The level of impact expected.", + "x-ms-enum": { + "name": "ImpactLevel", + "modelAsString": true, + "values": [ + { + "value": "Invalid" + }, + { + "value": "None" + }, + { + "value": "Restart" + }, + { + "value": "RemoveData" + }, + { + "value": "RemoveNode" + } + ] + } + } + }, + "required": [ + "NodeName" + ] + }, + "NodeRepairImpactDescription": { + "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairImpactDescriptionBase" + }, + { + "type": "object", + "description": "NodeRepairImpactDescription", + "properties": { + "NodeImpactList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeImpact" + }, + "description": "The list of nodes impacted by a repair action and their respective expected impact." + } + } + } + ] + }, + "NodeRepairTargetDescription": { + "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairTargetDescriptionBase" + }, + { + "type": "object", + "description": "NodeRepairTargetDescription", + "properties": { + "NodeNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of nodes targeted by a repair action." + } + } + } + ] + }, + "RepairImpactDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairImpactKind", + "description": "The kind of repair impact represented by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairImpactKind": { + "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairImpactKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair impact is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair impact affects a set of Service Fabric nodes." + } + ] + } + }, + "RepairTargetDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairTargetKind", + "description": "The kind of repair target described by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairTargetKind": { + "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairTargetKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair target is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair target is a set of Service Fabric nodes." + } + ] + } + }, + "RepairTask": { + "type": "object", + "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value." + }, + "Description": { + "type": "string", + "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set." + }, + "State": { + "type": "string", + "enum": [ + "Invalid", + "Created", + "Claimed", + "Preparing", + "Approved", + "Executing", + "Restoring", + "Completed" + ], + "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.", + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Created", + "description": "Indicates that the repair task has been created." + }, + { + "value": "Claimed", + "description": "Indicates that the repair task has been claimed by a repair executor." + }, + { + "value": "Preparing", + "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully." + }, + { + "value": "Approved", + "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute." + }, + { + "value": "Executing", + "description": "Indicates that execution of the repair task is in progress." + }, + { + "value": "Restoring", + "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online." + }, + { + "value": "Completed", + "description": "Indicates that the repair task has completed, and no further state changes will occur." + } + ] + } + }, + "Flags": { + "type": "integer", + "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request" + }, + "Action": { + "type": "string", + "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set." + }, + "Target": { + "$ref": "#/definitions/RepairTargetDescriptionBase", + "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set." + }, + "Executor": { + "type": "string", + "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set." + }, + "ExecutorData": { + "type": "string", + "description": "A data string that the repair executor can use to store its internal state." + }, + "Impact": { + "$ref": "#/definitions/RepairImpactDescriptionBase", + "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set." + }, + "ResultStatus": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Cancelled", + "Interrupted", + "Failed", + "Pending" + ], + "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.", + "x-ms-enum": { + "name": "ResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Succeeded", + "description": "Indicates that the repair task completed execution successfully." + }, + { + "value": "Cancelled", + "description": "Indicates that the repair task was cancelled prior to execution." + }, + { + "value": "Interrupted", + "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed." + }, + { + "value": "Failed", + "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed." + }, + { + "value": "Pending", + "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing." + } + ] + } + }, + "ResultCode": { + "type": "integer", + "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "ResultDetails": { + "type": "string", + "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "History": { + "$ref": "#/definitions/RepairTaskHistory", + "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified." + }, + "PreparingHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Preparing state." + }, + "RestoringHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Restoring state." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state." + } + }, + "required": [ + "TaskId", + "Action", + "State" + ] + }, + "RepairTaskApproveDescription": { + "type": "object", + "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskCancelDescription": { + "type": "object", + "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + }, + "RequestAbort": { + "type": "boolean", + "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskDeleteDescription": { + "type": "object", + "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the completed repair task to be deleted." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskHealthCheckState": { + "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Skipped", + "TimedOut" + ], + "x-ms-enum": { + "name": "RepairTaskHealthCheckState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Indicates that the health check has not started." + }, + { + "value": "InProgress", + "description": "Indicates that the health check is in progress." + }, + { + "value": "Succeeded", + "description": "Indicates that the health check succeeded." + }, + { + "value": "Skipped", + "description": "Indicates that the health check was skipped." + }, + { + "value": "TimedOut", + "description": "Indicates that the health check timed out." + } + ] + } + }, + "RepairTaskHistory": { + "type": "object", + "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "CreatedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Created state." + }, + "ClaimedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Claimed state." + }, + "PreparingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Preparing state." + }, + "ApprovedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Approved state" + }, + "ExecutingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Executing state" + }, + "RestoringUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Restoring state" + }, + "CompletedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Completed state" + }, + "PreparingHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Preparing state." + }, + "PreparingHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Preparing state." + }, + "RestoringHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Restoring state." + }, + "RestoringHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Restoring state." + } + } + }, + "RepairTaskList": { + "type": "array", + "description": "A list of repair tasks.", + "items": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskUpdateHealthPolicyDescription": { + "type": "object", + "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task to be updated." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskUpdateInfo": { + "type": "object", + "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Version": { + "type": "string", + "description": "The new version of the repair task." + } + }, + "required": [ + "Version" + ] + }, + "ReconfigurationInformation": { + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.", + "properties": { + "PreviousConfigurationRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "Replica role before reconfiguration started." + }, + "ReconfigurationPhase": { + "$ref": "#/definitions/ReconfigurationPhase", + "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationType": { + "$ref": "#/definitions/ReconfigurationType", + "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time." + } + } + }, + "ReconfigurationPhase": { + "type": "string", + "description": "The reconfiguration phase of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Phase0", + "Phase1", + "Phase2", + "Phase3", + "Phase4", + "AbortPhaseZero" + ], + "x-ms-enum": { + "name": "ReconfigurationPhase", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration phase." + }, + { + "value": "None", + "description": "Specifies that there is no reconfiguration in progress." + }, + { + "value": "Phase0", + "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary." + }, + { + "value": "Phase1", + "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress." + }, + { + "value": "Phase2", + "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set." + }, + { + "value": "Phase3", + "description": "This phase is for internal use only." + }, + { + "value": "Phase4", + "description": "This phase is for internal use only." + }, + { + "value": "AbortPhaseZero", + "description": "This phase is for internal use only." + } + ] + } + }, + "ReconfigurationType": { + "type": "string", + "description": "The type of reconfiguration for replica of a stateful service.", + "enum": [ + "Unknown", + "SwapPrimary", + "Failover", + "Other" + ], + "x-ms-enum": { + "name": "ReconfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration type." + }, + { + "value": "SwapPrimary", + "description": "Specifies that the primary replica is being swapped with a different replica." + }, + { + "value": "Failover", + "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc." + }, + { + "value": "Other", + "description": "Reconfigurations where the primary replica is not changing." + } + ] + } + }, + "InfrastructureServiceResponse": { + "type": "string", + "format": "binary", + "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service." + }, + "UploadChunkRange": { + "type": "object", + "description": "Information about which portion of the file to upload.", + "properties": { + "StartPosition": { + "type": "string", + "description": "The start position of the portion of the file. It's represented by the number of bytes." + }, + "EndPosition": { + "type": "string", + "description": "The end position of the portion of the file. It's represented by the number of bytes." + } + } + }, + "UploadSessionInfo": { + "type": "object", + "description": "Information about an image store upload session. A session is associated with a relative path in the image store.", + "properties": { + "StoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "SessionId": { + "type": "string", + "format": "uuid", + "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the upload session was last modified." + }, + "FileSize": { + "type": "string", + "description": "The size in bytes of the uploading file." + }, + "ExpectedRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadChunkRange" + }, + "description": "List of chunk ranges that image store has not received yet." + } + } + }, + "UploadSession": { + "type": "object", + "description": "Information about a image store upload session", + "properties": { + "UploadSessions": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadSessionInfo" + }, + "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions." + } + } + }, + "ContainerLogs": { + "type": "object", + "description": "Container logs.", + "properties": { + "Content": { + "type": "string", + "description": "Container logs." + } + } + }, + "ScalingPolicyDescription": { + "type": "object", + "description": "Describes how the scaling should be performed", + "required": [ + "ScalingTrigger", + "ScalingMechanism" + ], + "properties": { + "ScalingTrigger": { + "$ref": "#/definitions/ScalingTriggerDescription", + "description": "Specifies the trigger associated with this scaling policy" + }, + "ScalingMechanism": { + "$ref": "#/definitions/ScalingMechanismDescription", + "description": "Specifies the mechanism associated with this scaling policy" + } + } + }, + "ScalingPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicyDescription" + }, + "description": "A list that describes the scaling policies." + }, + "ScalingTriggerDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingTriggerKind", + "description": "Specifies the kind of scaling trigger" + } + } + }, + "ScalingMechanismDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingMechanismKind", + "description": "Specifies the kind of scaling mechanism" + } + } + }, + "ScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "AveragePartitionLoad", + "AverageServiceLoad" + ], + "x-ms-enum": { + "name": "ScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "AveragePartitionLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1." + }, + { + "value": "AverageServiceLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2." + } + ] + } + }, + "ScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "PartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PartitionInstanceCount", + "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2." + } + ] + } + }, + "AveragePartitionLoadScalingTrigger": { + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AverageServiceLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "PartitionInstanceCount", + "required": [ + "MinInstanceCount", + "MaxInstanceCount", + "ScaleIncrement" + ], + "properties": { + "MinInstanceCount": { + "type": "integer", + "description": "Minimum number of instances of the partition." + }, + "MaxInstanceCount": { + "type": "integer", + "description": "Maximum number of instances of the partition." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "MinPartitionCount", + "MaxPartitionCount", + "ScaleIncrement" + ], + "properties": { + "MinPartitionCount": { + "type": "integer", + "description": "Minimum number of named partitions of the service." + }, + "MaxPartitionCount": { + "type": "integer", + "description": "Maximum number of named partitions of the service." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationCreatedEvent": { + "description": "Application Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "Application definition kind." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "ApplicationDefinitionKind" + ] + } + ], + "x-ms-discriminator-value": "ApplicationCreated" + }, + "ApplicationDeletedEvent": { + "description": "Application Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + } + ], + "x-ms-discriminator-value": "ApplicationDeleted" + }, + "ApplicationHealthReportCreatedEvent": { + "description": "Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ApplicationHealthReportCreated" + }, + "ApplicationHealthReportExpiredEvent": { + "description": "Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ApplicationHealthReportExpired" + }, + "ApplicationUpgradeCompleteEvent": { + "description": "Application Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeComplete" + }, + "ApplicationUpgradeDomainCompleteEvent": { + "description": "Application Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Upgrade time of domain in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeDomainComplete" + }, + "ApplicationUpgradeRollbackCompleteEvent": { + "description": "Application Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackComplete" + }, + "ApplicationUpgradeRollbackStartEvent": { + "description": "Application Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackStart" + }, + "ApplicationUpgradeStartEvent": { + "description": "Application Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeStart" + }, + "DeployedApplicationHealthReportCreatedEvent": { + "description": "Deployed Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedApplicationHealthReportCreated" + }, + "DeployedApplicationHealthReportExpiredEvent": { + "description": "Deployed Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired" + }, + "ProcessDeactivatedEvent": { + "description": "Process Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ExeName": { + "type": "string", + "description": "Name of executable." + }, + "ProcessId": { + "type": "integer", + "format": "int64", + "description": "Process Id." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ExeName", + "ProcessId", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "ProcessDeactivated" + }, + "ContainerDeactivatedEvent": { + "description": "Container Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ImageName": { + "type": "string", + "description": "Name of Container image." + }, + "ContainerName": { + "type": "string", + "description": "Name of Container." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ImageName", + "ContainerName", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "ContainerDeactivated" + }, + "NodeAbortedEvent": { + "description": "Node Aborted event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeAborted" + }, + "NodeAbortingEvent": { + "description": "Node Aborting event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeAborting" + }, + "NodeAddedEvent": { + "description": "Node Added event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ] + } + ], + "x-ms-discriminator-value": "NodeAdded" + }, + "NodeCloseEvent": { + "description": "Node Close event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "string", + "description": "Id of Node instance." + }, + "Error": { + "type": "string", + "description": "Describes error." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "Error" + ] + } + ], + "x-ms-discriminator-value": "NodeClose" + }, + "NodeClosingEvent": { + "description": "Node Closing event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeClosing" + }, + "NodeDeactivateCompleteEvent": { + "description": "Node Deactivate Complete event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "EffectiveDeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + }, + "BatchIdsWithDeactivateIntent": { + "type": "string", + "description": "Batch Ids." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time." + } + }, + "required": [ + "NodeInstance", + "EffectiveDeactivateIntent", + "BatchIdsWithDeactivateIntent", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "NodeDeactivateComplete" + }, + "NodeDeactivateStartEvent": { + "description": "Node Deactivate Start event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "BatchId": { + "type": "string", + "description": "Batch Id." + }, + "DeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + } + }, + "required": [ + "NodeInstance", + "BatchId", + "DeactivateIntent" + ] + } + ], + "x-ms-discriminator-value": "NodeDeactivateStart" + }, + "NodeDownEvent": { + "description": "Node Down event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last up." + } + }, + "required": [ + "NodeInstance", + "LastNodeUpAt" + ] + } + ], + "x-ms-discriminator-value": "NodeDown" + }, + "NodeHealthReportCreatedEvent": { + "description": "Node Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "NodeHealthReportCreated" + }, + "NodeHealthReportExpiredEvent": { + "description": "Node Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "NodeHealthReportExpired" + }, + "NodeOpenedSuccessEvent": { + "description": "Node Opened Success event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeOpenedSuccess" + }, + "NodeOpenFailedEvent": { + "description": "Node Open Failed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + }, + "Error": { + "type": "string", + "description": "Describes the error." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion", + "Error" + ] + } + ], + "x-ms-discriminator-value": "NodeOpenFailed" + }, + "NodeOpeningEvent": { + "description": "Node Opening event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeOpening" + }, + "NodeRemovedEvent": { + "description": "Node Removed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ] + } + ], + "x-ms-discriminator-value": "NodeRemoved" + }, + "NodeUpEvent": { + "description": "Node Up event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last down." + } + }, + "required": [ + "NodeInstance", + "LastNodeDownAt" + ] + } + ], + "x-ms-discriminator-value": "NodeUp" + }, + "PartitionHealthReportCreatedEvent": { + "description": "Partition Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "PartitionHealthReportCreated" + }, + "PartitionHealthReportExpiredEvent": { + "description": "Partition Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "PartitionHealthReportExpired" + }, + "PartitionReconfigurationCompletedEvent": { + "description": "Partition Reconfiguration Completed event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "Id of Node instance." + }, + "ServiceType": { + "type": "string", + "description": "Type of Service." + }, + "CcEpochDataLossVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochDataLoss version." + }, + "CcEpochConfigVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochConfig version." + }, + "ReconfigType": { + "type": "string", + "description": "Type of reconfiguration." + }, + "Result": { + "type": "string", + "description": "Describes reconfiguration result." + }, + "Phase0DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase0 in milli-seconds." + }, + "Phase1DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase1 in milli-seconds." + }, + "Phase2DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase2 in milli-seconds." + }, + "Phase3DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase3 in milli-seconds." + }, + "Phase4DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase4 in milli-seconds." + }, + "TotalDurationMs": { + "type": "number", + "format": "double", + "description": "Total duration in milli-seconds." + } + }, + "required": [ + "NodeName", + "NodeInstanceId", + "ServiceType", + "CcEpochDataLossVersion", + "CcEpochConfigVersion", + "ReconfigType", + "Result", + "Phase0DurationMs", + "Phase1DurationMs", + "Phase2DurationMs", + "Phase3DurationMs", + "Phase4DurationMs", + "TotalDurationMs" + ] + } + ], + "x-ms-discriminator-value": "PartitionReconfigurationCompleted" + }, + "PartitionPrimaryMoveAnalysisEvent": { + "description": "Partition Primary Move Analysis event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionAnalysisEvent" + }, + { + "type": "object", + "properties": { + "WhenMoveCompleted": { + "type": "string", + "format": "date-time", + "description": "Time when the move was completed." + }, + "PreviousNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "CurrentNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "MoveReason": { + "type": "string", + "description": "Move reason." + }, + "RelevantTraces": { + "type": "string", + "description": "Relevant traces." + } + }, + "required": [ + "WhenMoveCompleted", + "PreviousNode", + "CurrentNode", + "MoveReason", + "RelevantTraces" + ] + } + ], + "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis" + }, + "ServiceCreatedEvent": { + "description": "Service Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion", + "PartitionId" + ] + } + ], + "x-ms-discriminator-value": "ServiceCreated" + }, + "ServiceDeletedEvent": { + "description": "Service Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion" + ] + } + ], + "x-ms-discriminator-value": "ServiceDeleted" + }, + "ServiceHealthReportCreatedEvent": { + "description": "Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ServiceHealthReportCreated" + }, + "ServiceHealthReportExpiredEvent": { + "description": "Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ServiceHealthReportExpired" + }, + "DeployedServiceHealthReportCreatedEvent": { + "description": "Deployed Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TTLTimespan": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifestName", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportCreated" + }, + "DeployedServiceHealthReportExpiredEvent": { + "description": "Deployed Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceManifest": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TTLTimespan": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifest", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportExpired" + }, + "StatefulReplicaHealthReportCreatedEvent": { + "description": "Stateful Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatefulReplicaHealthReportCreated" + }, + "StatefulReplicaHealthReportExpiredEvent": { + "description": "Stateful Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired" + }, + "StatelessReplicaHealthReportCreatedEvent": { + "description": "Stateless Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatelessReplicaHealthReportCreated" + }, + "StatelessReplicaHealthReportExpiredEvent": { + "description": "Stateless Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired" + }, + "ClusterHealthReportCreatedEvent": { + "description": "Cluster Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ClusterHealthReportCreated" + }, + "ClusterHealthReportExpiredEvent": { + "description": "Cluster Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ClusterHealthReportExpired" + }, + "ClusterUpgradeCompleteEvent": { + "description": "Cluster Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeComplete" + }, + "ClusterUpgradeDomainCompleteEvent": { + "description": "Cluster Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Duration of domain upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeDomainComplete" + }, + "ClusterUpgradeRollbackCompleteEvent": { + "description": "Cluster Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackComplete" + }, + "ClusterUpgradeRollbackStartEvent": { + "description": "Cluster Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackStart" + }, + "ClusterUpgradeStartEvent": { + "description": "Cluster Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "CurrentClusterVersion": { + "type": "string", + "description": "Current Cluster version." + }, + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "CurrentClusterVersion", + "TargetClusterVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeStart" + }, + "ChaosStoppedEvent": { + "description": "Chaos Stopped event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "Reason": { + "type": "string", + "description": "Describes reason." + } + }, + "required": [ + "Reason" + ] + } + ], + "x-ms-discriminator-value": "ChaosStopped" + }, + "ChaosStartedEvent": { + "description": "Chaos Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "Maximum number of concurrent faults." + }, + "TimeToRunInSeconds": { + "type": "number", + "format": "double", + "description": "Time to run in seconds." + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "number", + "format": "double", + "description": "Maximum timeout for cluster stabilization in seconds." + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between iterations in seconds." + }, + "WaitTimeBetweenFautlsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between faults in seconds." + }, + "MoveReplicaFaultEnabled": { + "type": "boolean", + "description": "Indicates MoveReplica fault is enabled." + }, + "IncludedNodeTypeList": { + "type": "string", + "description": "List of included Node types." + }, + "IncludedApplicationList": { + "type": "string", + "description": "List of included Applications." + }, + "ClusterHealthPolicy": { + "type": "string", + "description": "Health policy." + }, + "ChaosContext": { + "type": "string", + "description": "Chaos Context." + } + }, + "required": [ + "MaxConcurrentFaults", + "TimeToRunInSeconds", + "MaxClusterStabilizationTimeoutInSeconds", + "WaitTimeBetweenIterationsInSeconds", + "WaitTimeBetweenFautlsInSeconds", + "MoveReplicaFaultEnabled", + "IncludedNodeTypeList", + "IncludedApplicationList", + "ClusterHealthPolicy", + "ChaosContext" + ] + } + ], + "x-ms-discriminator-value": "ChaosStarted" + }, + "ChaosRestartNodeFaultCompletedEvent": { + "description": "Chaos Restart Node Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + } + }, + "required": [ + "NodeInstanceId", + "FaultGroupId", + "FaultId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartNodeFaultCompleted" + }, + "ChaosRestartCodePackageFaultScheduledEvent": { + "description": "Chaos Restart Code Package Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "CodePackageName": { + "type": "string", + "description": "Code package name." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "NodeName", + "ServiceManifestName", + "CodePackageName", + "ServicePackageActivationId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartCodePackageFaultScheduled" + }, + "ChaosRestartCodePackageFaultCompletedEvent": { + "description": "Chaos Restart Code Package Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "CodePackageName": { + "type": "string", + "description": "Code package name." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "NodeName", + "ServiceManifestName", + "CodePackageName", + "ServicePackageActivationId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartCodePackageFaultCompleted" + }, + "ChaosRemoveReplicaFaultScheduledEvent": { + "description": "Chaos Remove Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRemoveReplicaFaultScheduled" + }, + "ChaosRemoveReplicaFaultCompletedEvent": { + "description": "Chaos Remove Replica Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRemoveReplicaFaultCompleted" + }, + "ChaosMoveSecondaryFaultScheduledEvent": { + "description": "Chaos Move Secondary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "SourceNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "DestinationNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "SourceNode", + "DestinationNode", + "ForcedMove" + ] + } + ], + "x-ms-discriminator-value": "ChaosMoveSecondaryFaultScheduled" + }, + "ChaosMovePrimaryFaultScheduledEvent": { + "description": "Chaos Move Primary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "NodeTo": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "NodeTo", + "ForcedMove" + ] + } + ], + "x-ms-discriminator-value": "ChaosMovePrimaryFaultScheduled" + }, + "ChaosRestartReplicaFaultScheduledEvent": { + "description": "Chaos Restart Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartReplicaFaultScheduled" + }, + "ChaosRestartNodeFaultScheduledEvent": { + "description": "Chaos Restart Node Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + } + }, + "required": [ + "NodeInstanceId", + "FaultGroupId", + "FaultId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartNodeFaultScheduled" + } + }, + "parameters": { + "ApiVersion_6-0-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0-preview" + ], + "required": true, + "default": "6.0-preview", + "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-0-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0-preview", + "description": "The version number for the preview functionality of 6.0 runtime." + } + ] + } + }, + "ApiVersion_6-0_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0" + ], + "required": true, + "default": "6.0", + "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-0_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0", + "description": "The 6.0 version of the API." + } + ] + } + }, + "ApiVersion_6-1_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.1" + ], + "required": true, + "default": "6.1", + "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-1_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.1", + "description": "The 6.1 version of the API." + } + ] + } + }, + "ApiVersion_6-2_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2" + ], + "required": true, + "default": "6.2", + "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-2_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2", + "description": "The 6.2 version of the API." + } + ] + } + }, + "ApiVersion_6-2-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2-preview" + ], + "required": true, + "default": "6.2-preview", + "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-2-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2-preview", + "description": "The version number for the preview functionality of 6.2 runtime" + } + ] + } + }, + "ApplicationDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationDefinitionKindFilter", + "description": "Used to filter on ApplicationDefinitionKind which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationHealthPolicyOptionalBodyParam": { + "name": "ApplicationHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + }, + "ApplicationIdRequiredPathParam": { + "name": "applicationId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationsHealthStateFilterOptionalQueryParam": { + "name": "ApplicationsHealthStateFilter", + "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationTypeDefinitionKindFilter", + "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeNameOptionalQueryParam": { + "name": "ApplicationTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The application type name used to filter the applications to query for. This value should not contain the application type version." + }, + "ApplicationTypeNameRequiredPathParam": { + "name": "applicationTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the application type." + }, + "ApplicationTypeVersionOptionalQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The version of the application type." + }, + "ApplicationTypeVersionRequiredQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The version of the application type." + }, + "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": { + "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam", + "in": "body", + "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + } + }, + "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": { + "name": "ClusterConfigurationUpgradeDescription", + "in": "body", + "description": "Parameters for a standalone cluster configuration upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeDescription" + } + }, + "ClusterHealthPoliciesOptionalBodyParam": { + "name": "ClusterHealthPolicies", + "in": "body", + "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicies" + } + }, + "ClusterHealthPolicyOptionalBodyParam": { + "name": "ClusterHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicy" + } + }, + "ClusterHealthChunkQueryDescriptionOptionalBodyParam": { + "name": "ClusterHealthChunkQueryDescription", + "in": "body", + "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthChunkQueryDescription" + } + }, + "CodePackageInstanceIdRequiredQueryParam": { + "name": "CodePackageInstanceId", + "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "CodeVersionOptionalQueryParam": { + "name": "CodeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The product version of Service Fabric." + }, + "ConfigVersionOptionalQueryParam": { + "name": "ConfigVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The config version of Service Fabric." + }, + "ConfigurationApiVersionRequiredQueryParam": { + "name": "ConfigurationApiVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The API version of the Standalone cluster json configuration." + }, + "ContainerApiRequiredBodyParam": { + "name": "ContainerApiRequestBody", + "in": "body", + "description": "Parameters for making container API call", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ContainerApiRequestBody" + } + }, + "ContinuationTokenOptionalQueryParam": { + "name": "ContinuationToken", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results then the continuation token does not contain a value. The value of this parameter should not be URL encoded." + }, + "DeployedApplicationsHealthStateFilterOptionalQueryParam": { + "name": "DeployedApplicationsHealthStateFilter", + "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServicePackagesHealthStateFilterOptionalQueryParam": { + "name": "DeployedServicePackagesHealthStateFilter", + "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag based enumeration, so the value can be a combination of these value obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeploymentNameRequiredPathParam": { + "name": "deploymentName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the deployment." + }, + "EventsHealthStateFilterOptionalQueryParam": { + "name": "EventsHealthStateFilter", + "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ExcludeApplicationParametersOptionalQueryParam": { + "name": "ExcludeApplicationParameters", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "The flag that specifies whether application parameters will be excluded from the result." + }, + "HealthInformationRequiredBodyParam": { + "name": "HealthInformation", + "in": "body", + "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/HealthInformation" + } + }, + "NodeNameRequiredPathParam": { + "name": "nodeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the node." + }, + "NodesHealthStateFilterOptionalQueryParam": { + "name": "NodesHealthStateFilter", + "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "NodeStatusFilterOptionalQueryParam": { + "name": "NodeStatusFilter", + "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default", + "all", + "up", + "down", + "enabling", + "disabling", + "disabled", + "unknown", + "removed" + ], + "required": false, + "default": "default", + "x-ms-enum": { + "name": "NodeStatusFilter", + "modelAsString": true, + "values": [ + { + "value": "default", + "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." + }, + { + "value": "all", + "description": "This filter value will match all of the nodes." + }, + { + "value": "up", + "description": "This filter value will match nodes that are Up." + }, + { + "value": "down", + "description": "This filter value will match nodes that are Down." + }, + { + "value": "enabling", + "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling." + }, + { + "value": "disabling", + "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling." + }, + { + "value": "disabled", + "description": "This filter value will match nodes that are Disabled." + }, + { + "value": "unknown", + "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime." + }, + { + "value": "removed", + "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API." + } + ] + } + }, + "PartitionIdOptionalQueryParam": { + "name": "PartitionId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": false, + "description": "The identity of the partition." + }, + "PartitionIdRequiredPathParam": { + "name": "partitionId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "format": "uuid", + "required": true, + "description": "The identity of the partition." + }, + "ProvisionFabricDescriptionRequiredBodyParam": { + "name": "ProvisionFabricDescription", + "in": "body", + "description": "Describes the parameters for provisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionFabricDescription" + } + }, + "UnprovisionFabricDescriptionRequiredBodyParam": { + "name": "UnprovisionFabricDescription", + "in": "body", + "description": "Describes the parameters for unprovisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionFabricDescription" + } + }, + "ResumeClusterUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeClusterUpgradeDescription" + } + }, + "UpdateClusterUpgradeDescriptionRequiredBodyParam": { + "name": "UpdateClusterUpgradeDescription", + "in": "body", + "description": "Parameters for updating a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UpdateClusterUpgradeDescription" + } + }, + "StartClusterUpgradeDescriptionRequiredBodyParam": { + "name": "StartClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for starting a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/StartClusterUpgradeDescription" + } + }, + "ReplicaHealthReportServiceKindRequiredQueryParam": { + "name": "ReplicaHealthReportServiceKind", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.", + "type": "string", + "enum": [ + "Stateless", + "Stateful" + ], + "default": "Stateful", + "x-ms-enum": { + "name": "ReplicaHealthReportServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1" + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ReplicaIdRequiredPathParam": { + "name": "replicaId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identifier of the replica." + }, + "ReplicasHealthStateFilerOptionalQueryParam": { + "name": "ReplicasHealthStateFilter", + "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ServiceIdRequiredPathParam": { + "name": "serviceId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service. This is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServiceManifestNameRequiredQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServicePackageNameRequiredPathParam": { + "name": "servicePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the service package." + }, + "ServicesHealthStateFilterOptionalQueryParam": { + "name": "ServicesHealthStateFilter", + "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "CreateServiceFromTemplateRequiredBodyParam": { + "name": "ServiceFromTemplateDescription", + "in": "body", + "description": "Describes the service that needs to be created from the template defined in the application manifest.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceFromTemplateDescription" + } + }, + "ServiceTypeNameOptionalQueryParam": { + "name": "ServiceTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The service type name used to filter the services to query for." + }, + "InfrastructureCommandRequiredQueryParam": { + "name": "Command", + "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "InfrastructureServiceIdOptionalQueryParam": { + "name": "ServiceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that have more than one instance of infrastructure service running.", + "required": false + }, + "ForceRemoveOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "ForceRemoveReplicaOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "DeactivationIntentDescriptionRequiredBodyParam": { + "name": "DeactivationIntentDescription", + "in": "body", + "description": "Describes the intent or reason for deactivating the node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeactivationIntentDescription" + } + }, + "RestartNodeDescriptionRequiredBodyParam": { + "name": "RestartNodeDescription", + "in": "body", + "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartNodeDescription" + } + }, + "ApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeDescription", + "in": "body", + "description": "Parameters for an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeDescription" + } + }, + "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": { + "name": "ComposeDeploymentUpgradeDescription", + "in": "body", + "description": "Parameters for upgrading compose deployment.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeDescription" + } + }, + "ApplicationTypeImageStorePathRequiredBodyParam": { + "name": "ApplicationTypeImageStorePath", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationTypeImageStorePath" + } + }, + "UnprovisionApplicationTypeRequiredBodyParam": { + "name": "UnprovisionApplicationTypeDescriptionInfo", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo" + } + }, + "UpgradeOrchestrationServiceStateRequiredBodyParam": { + "name": "UpgradeOrchestrationServiceState", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "ChaosParametersRequiredBodyParam": { + "name": "ChaosParameters", + "in": "body", + "description": "Describes all the parameters to configure a Chaos run.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosParameters" + } + }, + "StartTimeUtcOptionalQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "EndTimeUtcOptionalQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Please consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/en-us/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "ApplicationNameRequiredQueryParam": { + "name": "ApplicationName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme." + }, + "CreateComposeDeploymentRequiredBodyParam": { + "name": "CreateComposeDeploymentDescription", + "in": "body", + "description": "Describes the compose deployment that needs to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/CreateComposeDeploymentDescription" + } + }, + "PasswordEncryptedOptionalQueryParam": { + "name": "PasswordEncrypted", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Indicates that supplied container repository password is encrypted." + }, + "RepositoryPasswordOptionalQueryParam": { + "name": "RepositoryPassword", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The password for supplied username to connect to container repository." + }, + "RepositoryUserNameOptionalQueryParam": { + "name": "RepositoryUserName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The user name to connect to container repository." + }, + "MaxResultsOptionalQueryParam": { + "name": "MaxResults", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "minimum": 0, + "default": 0, + "required": false, + "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged queries includes as many results as possible that fit in the return message." + }, + "ApplicationDescriptionRequiredBodyParam": { + "name": "ApplicationDescription", + "in": "body", + "description": "Description for creating an application.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationDescription" + } + }, + "ServiceDescriptionRequiredBodyParam": { + "name": "ServiceDescription", + "in": "body", + "description": "The information necessary to create a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "ServiceUpdateDescriptionRequiredBodyParam": { + "name": "ServiceUpdateDescription", + "in": "body", + "description": "The information necessary to update a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceUpdateDescription" + } + }, + "ImageStoreCopyDescriptionRequiredBodyParam": { + "name": "ImageStoreCopyDescription", + "in": "body", + "description": "Describes the copy description for the image store.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ImageStoreCopyDescription" + } + }, + "CodePackageNameOptionalQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "CodePackageNameRequiredQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "RestartDeployedCodePackageRequiredBodyParam": { + "name": "RestartDeployedCodePackageDescription", + "in": "body", + "description": "Describes the deployed code package on Service Fabric node to restart.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartDeployedCodePackageDescription" + } + }, + "PartitionsHealthStateFilterOptionalQueryParam": { + "name": "PartitionsHealthStateFilter", + "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServiceType_ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." + }, + "ServiceTypeNameRequiredPathParam": { + "name": "serviceTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Specifies the name of a Service Fabric service type." + }, + "ImageStoreContentPathRequiredPathParam": { + "name": "contentPath", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "Relative path to file or folder in the image store from its root." + }, + "PartitionKeyTypeOptionalQueryParam": { + "name": "PartitionKeyType", + "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "PartitionKeyValueOptionalQueryParam": { + "name": "PartitionKeyValue", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named." + }, + "PreviousRspVersionOptionalQueryParam": { + "name": "PreviousRspVersion", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was got previously is stale." + }, + "DataLossModeRequiredQueryParam": { + "name": "DataLossMode", + "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "PartialDataLoss", + "FullDataLoss" + ], + "required": true, + "x-ms-enum": { + "name": "DataLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "PartialDataLoss", + "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition." + }, + { + "value": "FullDataLoss", + "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost." + } + ] + } + }, + "FaultOperationIdRequiredQueryParam": { + "name": "OperationId", + "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true + }, + "ForceRequiredQueryParam": { + "name": "Force", + "description": "Indicates whether to gracefully rollback and clean up internal system state modified by executing the user-induced operation.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": true, + "default": false + }, + "NodeInstanceIdRequiredQueryParam": { + "name": "NodeInstanceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API." + }, + "NodeTransitionTypeRequiredQueryParam": { + "name": "NodeTransitionType", + "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "Start", + "Stop" + ], + "required": true, + "x-ms-enum": { + "name": "NodeTransitionType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "Start", + "description": "Transition a stopped node to up." + }, + { + "value": "Stop", + "description": "Transition an up node to stopped." + } + ] + } + }, + "QuorumLossDurationRequiredQueryParam": { + "name": "QuorumLossDuration", + "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true + }, + "QuorumLossModeRequiredQueryParam": { + "name": "QuorumLossMode", + "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "QuorumReplicas", + "AllReplicas" + ], + "required": true, + "x-ms-enum": { + "name": "QuorumLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "QuorumReplicas", + "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss." + }, + { + "value": "AllReplicas" + } + ] + } + }, + "RestartPartitionModeRequiredQueryParam": { + "name": "RestartPartitionMode", + "description": "Describe which partitions to restart.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "AllReplicasOrInstances", + "OnlyActiveSecondaries" + ], + "required": true, + "x-ms-enum": { + "name": "RestartPartitionMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "AllReplicasOrInstances", + "description": "All replicas or instances in the partition are restarted at once." + }, + { + "value": "OnlyActiveSecondaries", + "description": "Only the secondary replicas are restarted." + } + ] + } + }, + "StateFilterRequiredQueryParam": { + "name": "StateFilter", + "description": "Used to filter on OperationState's for user-induced operations.\n65535 - select All\n1 - select Running\n2 - select RollingBack\n8 - select Completed\n16 - select Faulted\n32 - select Cancelled\n64 - select ForceCancelled", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "StopDurationInSecondsRequiredQueryParam": { + "name": "StopDurationInSeconds", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int32", + "minimum": 0, + "required": true, + "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up." + }, + "TypeFilterRequiredQueryParam": { + "name": "TypeFilter", + "description": "Used to filter on OperationType for user-induced operations.\n65535 - select all\n1 - select PartitionDataLoss.\n2 - select PartitionQuorumLoss.\n4 - select PartitionRestart.\n8 - select NodeTransition.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "DeployServicePackageToNodeRequiredBodyParam": { + "name": "DeployServicePackageToNodeDescription", + "in": "body", + "description": "Describes information for deploying a service package to a Service Fabric node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeployServicePackageToNodeDescription" + } + }, + "ResumeApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeApplicationUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeApplicationUpgradeDescription" + } + }, + "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeUpdateDescription", + "in": "body", + "description": "Parameters for updating an existing application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeUpdateDescription" + } + }, + "TimeoutOptionalQueryParam": { + "name": "timeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "required": false, + "minimum": 1, + "maximum": 4294967295, + "default": 60, + "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." + }, + "NameDescriptionRequiredBodyParam": { + "name": "NameDescription", + "in": "body", + "description": "Describes the Service Fabric name to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NameDescription" + } + }, + "NameIdRequiredPathParam": { + "name": "nameId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The Service Fabric name, without the 'fabric:' URI scheme." + }, + "RecursiveOptionalQueryParam": { + "name": "Recursive", + "description": "Allows specifying that the search performed should be recursive.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeValuesOptionalQueryParam": { + "name": "IncludeValues", + "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "PropertyDescriptionRequiredBodyParam": { + "name": "PropertyDescription", + "in": "body", + "description": "Describes the Service Fabric property to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyDescription" + } + }, + "PropertyNameRequiredQueryParam": { + "name": "PropertyName", + "description": "Specifies the name of the property to get.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "PropertyBatchDescriptionListRequiredBodyParam": { + "name": "PropertyBatchDescriptionList", + "in": "body", + "description": "Describes the property batch operations to be submitted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyBatchDescriptionList" + } + }, + "ImmediateOptionalQueryParam": { + "name": "Immediate", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "A flag which indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." + }, + "ExcludeHealthStatisticsOptionalQueryParam": { + "name": "ExcludeHealthStatistics", + "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": { + "name": "IncludeSystemApplicationHealthStatistics", + "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeHealthStateOptionalQueryParam": { + "name": "IncludeHealthState", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time." + }, + "BackupPolicyDescriptionRequiredBodyParam": { + "name": "BackupPolicyDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the backup policy.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "BackupPolicyNameRequiredPathParam": { + "name": "backupPolicyName", + "in": "path", + "description": "The name of the backup policy.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "EnableBackupDescriptionRequiredBodyParam": { + "name": "EnableBackupDescription", + "in": "body", + "description": "Specifies the parameters for enabling backup.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/EnableBackupDescription" + } + }, + "RestorePartitionDescriptionRequiredBodyParam": { + "name": "RestorePartitionDescription", + "in": "body", + "description": "Describes the parameters to restore the partition.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestorePartitionDescription" + } + }, + "RestoreTimeoutOptionalQueryParam": { + "name": "RestoreTimeout", + "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 10 + }, + "BackupPartitionDescriptionOptionalBodyParam": { + "name": "BackupPartitionDescription", + "in": "body", + "required": false, + "x-ms-parameter-location": "method", + "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.", + "schema": { + "$ref": "#/definitions/BackupPartitionDescription" + } + }, + "BackupTimeoutOptionalQueryParam": { + "name": "BackupTimeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.", + "default": 10 + }, + "LatestOptionalQueryParam": { + "name": "Latest", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.", + "required": false, + "default": false + }, + "StartDateTimeFilterOptionalQueryParam": { + "name": "StartDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." + }, + "EndDateTimeFilterOptionalQueryParam": { + "name": "EndDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." + }, + "GetBackupByStorageQueryDescriptionRequiredBodyParam": { + "name": "GetBackupByStorageQueryDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the filters and backup storage details to be used for enumerating backups.", + "schema": { + "$ref": "#/definitions/GetBackupByStorageQueryDescription" + } + }, + "RepairTaskApproveDescriptionRequiredBodyParam": { + "name": "RepairTaskApproveDescription", + "in": "body", + "description": "Describes the repair task to be approved.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskApproveDescription" + } + }, + "RepairTaskCancelDescriptionRequiredBodyParam": { + "name": "RepairTaskCancelDescription", + "in": "body", + "description": "Describes the repair task to be cancelled.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskCancelDescription" + } + }, + "RepairTaskDeleteDescriptionRequiredBodyParam": { + "name": "RepairTaskDeleteDescription", + "in": "body", + "description": "Describes the repair task to be deleted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskDeleteDescription" + } + }, + "RepairTaskExecutorFilterOptionalQueryParam": { + "name": "ExecutorFilter", + "description": "The name of the repair executor whose claimed tasks should be included in the list.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskIdFilterOptionalQueryParam": { + "name": "TaskIdFilter", + "description": "The repair task ID prefix to be matched.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskRequiredBodyParam": { + "name": "RepairTask", + "in": "body", + "description": "Describes the repair task to be created or updated.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskStateFilterOptionalQueryParam": { + "name": "StateFilter", + "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": { + "name": "RepairTaskUpdateHealthPolicyDescription", + "in": "body", + "description": "Describes the repair task healthy policy to be updated.", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription" + } + }, + "UploadSessionIdRequiredQueryParam": { + "name": "session-id", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true, + "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed." + }, + "UploadFileChunkContentRangeHeaderParam": { + "name": "Content-Range", + "in": "header", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes." + }, + "TailOptionalQueryParam": { + "name": "Tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs." + }, + "ChaosScheduleRequiredBodyParam": { + "name": "ChaosSchedule", + "in": "body", + "description": "Describes the schedule used by Chaos.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "StartTimeUtcRequiredQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EndTimeUtcRequiredQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EventsTypesFilterOptionalQueryParam": { + "name": "EventsTypesFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response." + }, + "ExcludeAnalysisEventsOptionalQueryParam": { + "name": "ExcludeAnalysisEvents", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the retrieval of AnalysisEvents if true is passed." + }, + "SkipCorrelationLookupOptionalQueryParam": { + "name": "SkipCorrelationLookup", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated." + }, + "EventInstanceIdRequiredPathParam": { + "name": "eventInstanceId", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The EventInstanceId." + }, + "PreviousOptionalQueryParam": { + "name": "Previous", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.", + "required": false, + "default": false + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-1.json index 824a53cc691d..dc2775e07732 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-1.json @@ -1,13 +1,13 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": {} - }, - "responses": { - "202": { - } - } -} +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": {} + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-2.json index 4a0a56491d0b..48e257f80657 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-2.json @@ -1,19 +1,19 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": { - "BackupStorage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-3.json index 79260361fa1d..c827d97d6c81 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/BackupPartition-3.json @@ -1,20 +1,20 @@ -{ - "operationId": "BackupPartition", - "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "BackupPartitionDescription": { - "BackupStorage": { - "StorageKind": "FileShare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "mydomain\\backupaccount", - "PrimaryPassword": "abcd1234" - } - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "FileShare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "mydomain\\backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateApplication-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateApplication-1.json index c71542c2be64..bccda97daa0e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateApplication-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateApplication-1.json @@ -1,16 +1,16 @@ -{ - "operationId": "CreateApplication", - "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.", - "parameters": { - "api-version": "6.0", - "ApplicationDescription": { - "Name": "fabric:/samples/CalcApp", - "TypeVersion": "1.0", - "TypeName": "CalculatorApp" - } - }, - "responses": { - "201": { - } - } -} +{ + "operationId": "CreateApplication", + "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.", + "parameters": { + "api-version": "6.0", + "ApplicationDescription": { + "Name": "fabric:/samples/CalcApp", + "TypeVersion": "1.0", + "TypeName": "CalculatorApp" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-1.json index 6a57d125cf07..e12077c344f5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-1.json @@ -1,30 +1,30 @@ -{ - "operationId": "CreateBackupPolicy", - "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "BackupPolicyDescription": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "201": { - } - } +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "201": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-2.json index 6a555d1397a6..8d6b8c0b2f65 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateBackupPolicy-2.json @@ -1,27 +1,27 @@ -{ - "operationId": "CreateBackupPolicy", - "description": "This example shows how to create a backup policy which takes backup every 10 minutes with file share as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "BackupPolicyDescription": { - "Name": "FileShare10MinBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT10M" - }, - "Storage": { - "StorageKind": "FileShare", - "FriendlyName": "FileShare_myshare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "backupaccount", - "PrimaryPassword": "abcd1234" - } - } - }, - "responses": { - "201": { - } - } +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup every 10 minutes with file share as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "BackupPolicyDescription": { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "201": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateName-1.json index 87d2807cc3b8..bde8440d7677 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateName-1.json @@ -1,14 +1,14 @@ -{ - "operationId": "CreateName", - "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.", - "parameters": { - "api-version": "6.0", - "NameDescription": { - "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1" - } - }, - "responses": { - "201": { - } - } -} +{ + "operationId": "CreateName", + "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.", + "parameters": { + "api-version": "6.0", + "NameDescription": { + "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-1.json index 8b8c341523c2..c6186d87241b 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-1.json @@ -1,21 +1,21 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a basic stateless Service Fabric service.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateless", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test1", - "ServiceTypeName": "StatelessFrontendService", - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "InstanceCount": 4 - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateless Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 4 + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-2.json index b8d3c24c9f78..8549e33566a4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-2.json @@ -1,23 +1,23 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a basic stateful Service Fabric service.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateful", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test2", - "ServiceTypeName": "StatefulBackendService", - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "HasPersistedState": false - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateful Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "HasPersistedState": false + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-3.json index 1badea855fbb..5d7ea2bbafed 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-3.json @@ -1,47 +1,47 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateless", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test1", - "ServiceTypeName": "StatelessFrontendService", - "InitializationData": [], - "PartitionDescription": { - "PartitionScheme": "Singleton" - }, - "InstanceCount": 2, - "PlacementConstraints": "Color==Blue", - "CorrelationScheme": [], - "ServiceLoadMetrics": [], - "ServicePlacementPolicies": [], - "DefaultMoveCost": "Low", - "IsDefaultMoveCostSpecified": true, - "ServicePackageActivationMode": "ExclusiveProcess", - "ServiceDnsName": "test1.test", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AveragePartitionLoad", - "MetricName": "servicefabric:\/_CpuCores", - "LowerLoadThreshold": 0.300000, - "UpperLoadThreshold": 0.800000, - "ScaleIntervalInSeconds": 600 - }, - "ScalingMechanism": { - "Kind": "PartitionInstanceCount", - "MinInstanceCount": 1, - "MaxInstanceCount": 6, - "ScaleIncrement": 2 - } - } - ] - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 2, + "PlacementConstraints": "Color==Blue", + "CorrelationScheme": [], + "ServiceLoadMetrics": [], + "ServicePlacementPolicies": [], + "DefaultMoveCost": "Low", + "IsDefaultMoveCostSpecified": true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ServiceDnsName": "test1.test", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.300000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 1, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json index d72ec8f3b457..3ee3ba13b666 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json @@ -1,44 +1,44 @@ -{ - "operationId": "CreateService", - "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", - "parameters": { - "applicationId": "test", - "api-version": "6.0", - "ServiceDescription": { - "ServiceKind": "Stateful", - "ApplicationName": "fabric:\/test", - "ServiceName": "fabric:\/test\/test2", - "ServiceTypeName": "StatefulBackendService", - "InitializationData": [], - "PartitionDescription": { - "PartitionScheme": "NamedParitionSchemeDescription", - "Count" : 1, - "Names" : ["0"] - }, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize" : 2, - "HasPersistedState" : true, - "ServicePackageActivationMode": "ExclusiveProcess", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AverageServiceLoad", - "MetricName": "servicefabric:\/_MemoryInMB", - "LowerLoadThreshold": 500, - "UpperLoadThreshold": 900, - "ScaleIntervalInSeconds": 600 - }, - "ScalingMechanism": { - "Kind": "AddRemoveIncrementalNamedPartition", - "MinPartitionCount": 1, - "MaxPartitionCount": 3, - "ScaleIncrement": 1 - } - } - ] - } - }, - "responses": { - "202": {} - } +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "NamedParitionSchemeDescription", + "Count" : 1, + "Names" : ["0"] + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize" : 2, + "HasPersistedState" : true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AverageServiceLoad", + "MetricName": "servicefabric:\/_MemoryInMB", + "LowerLoadThreshold": 500, + "UpperLoadThreshold": 900, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "AddRemoveIncrementalNamedPartition", + "MinPartitionCount": 1, + "MaxPartitionCount": 3, + "ScaleIncrement": 1 + } + } + ] + } + }, + "responses": { + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DeleteBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DeleteBackupPolicy.json index 2eef49788ba9..bb4a059aca02 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DeleteBackupPolicy.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DeleteBackupPolicy.json @@ -1,12 +1,12 @@ -{ - "operationId": "DeleteBackupPolicy", - "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "SampleBackupPolicy" - }, - "responses": { - "200": { - } - } +{ + "operationId": "DeleteBackupPolicy", + "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "SampleBackupPolicy" + }, + "responses": { + "200": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableApplicationBackup.json index a2a85beaa18c..9c3f79dfcc49 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisableApplicationBackup", - "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisableApplicationBackup", + "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisablePartitionBackup.json index fd1eb6a6848d..d28c57331359 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisablePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisablePartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisablePartitionBackup", - "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisablePartitionBackup", + "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableServiceBackup.json index 8fc7ab651d64..a8d579114a69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/DisableServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "DisableServiceBackup", - "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "DisableServiceBackup", + "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableApplicationBackup.json index e3782a25d8a3..32d2aebf9790 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableApplicationBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnableApplicationBackup", - "description": "This example shows how to enable periodic backup for a stateful application.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnableApplicationBackup", + "description": "This example shows how to enable periodic backup for a stateful application.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnablePartitionBackup.json index 6d596f0718c3..681f1a34a1c5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnablePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnablePartitionBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnablePartitionBackup", - "description": "This example shows how to enable periodic backup for a stateful partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnablePartitionBackup", + "description": "This example shows how to enable periodic backup for a stateful partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableServiceBackup.json index 4f5f81b3436d..a70aabb7eccc 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/EnableServiceBackup.json @@ -1,15 +1,15 @@ -{ - "operationId": "EnableServiceBackup", - "description": "This example shows how to enable periodic backup for a stateful service.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "EnableBackupDescription": { - "BackupPolicyName": "DailyAzureBackupPolicy" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "EnableServiceBackup", + "description": "This example shows how to enable periodic backup for a stateful service.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-1.json index 4f57cba22d2a..cdc5bde7b7fd 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-1.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetAllEntitiesBackedUpByPolicy", - "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/DemoApp", - "Items": [ - { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - }, - { - "EntityKind": "Application", - "ApplicationName": "fabric:/DemoApp" - } - ] - } - } - } -} +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/DemoApp", + "Items": [ + { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + }, + { + "EntityKind": "Application", + "ApplicationName": "fabric:/DemoApp" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-2.json index 05d3854bdf38..a40150e05c98 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetAllEntitiesBackedUpByPolicy-2.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetAllEntitiesBackedUpByPolicy", - "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "MaxResults": 2, - "ContinuationToken": "fabric:/DemoApp" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "EntityKind": "Service", - "ServiceName": "fabric:/VotingApp/VotingActorService" - } - ] - } - } - } -} +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2, + "ContinuationToken": "fabric:/DemoApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "EntityKind": "Service", + "ServiceName": "fabric:/VotingApp/VotingActorService" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-1.json index e95dfced7ef9..2cc70dd82d79 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-1.json @@ -1,40 +1,40 @@ -{ - "operationId": "GetApplicationBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService", - "Items": [ - { - "Kind": "Application", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ApplicationName": "fabric:/CalcApp", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - }, - { - "Kind": "Service", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService", + "Items": [ + { + "Kind": "Application", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ApplicationName": "fabric:/CalcApp", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Service", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-2.json index 24a847b140c4..f1620fd55a75 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupConfigurationInfo-2.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetApplicationBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-1.json index 08c914915123..7cee9f28ad86 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-1.json @@ -1,105 +1,105 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-2.json index ac0fe0899e27..b0973826caf5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-2.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get the latest backup for each partition within an application.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get the latest backup for each partition within an application.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-3.json index 1c08ced64a00..f2c47a889359 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-4.json index 9cb6920d0c2c..0a79fb01b512 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationBackupList-4.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetApplicationBackupList", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationEventList.json index 22e0cd7a01c1..bd67cca12878 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationEventList.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetApplicationEventList", - "description": "This example shows how to get all application-related events during a certain time window.", - "parameters": { - "applicationId": "app1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App1Type", - "ApplicationTypeVersion": "1.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app1", - "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", - "TimeStamp": "2018-04-03T20:21:23.5774199Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetApplicationEventList", + "description": "This example shows how to get all application-related events during a certain time window.", + "parameters": { + "applicationId": "app1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoByName-1.json index cf3db52049cc..9d230b4a6666 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoByName-1.json @@ -1,27 +1,27 @@ -{ - "operationId": "GetApplicationInfo", - "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.", - "parameters": { - "api-version": "6.0", - "applicationId": "samples~CalculatorApp" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - }, - "204": { - "headers": {}, - "body": "" - } - } -} +{ + "operationId": "GetApplicationInfo", + "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.", + "parameters": { + "api-version": "6.0", + "applicationId": "samples~CalculatorApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-1.json index fdfb2ddb517d..df1f287e4104 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-1.json @@ -1,39 +1,39 @@ -{ - "operationId": "GetApplicationInfoList", - "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.1", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/samples/PQueueApp1", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-2.json index bdab44df784c..7b5ab210e830 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationInfoList-2.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetApplicationInfoList", - "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.1", - "MaxResults": 2, - "ContinuationToken": "fabric:/samples/PQueueApp1" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "TypeVersion": "1.0", - "Status": "Ready", - "Parameters": [], - "HealthState": "Ok", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2, + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-1.json index 7057ba96a7e4..a230d74d2b54 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-1.json @@ -1,86 +1,86 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.", - "parameters": { - "api-version": "6.0", - "MaxResults": 5 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueApp+2.0", - "Items": [ - { - "Name": "CalculatorApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "ServiceInstanceCount", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "CalculatorApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "ServiceInstanceCount", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "GatewayApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "GatewayPort", - "Value": "8505" - }, - { - "Key": "ServiceInstanceCount", - "Value": "1000" - } - ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueApp+2.0", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "GatewayPort", + "Value": "8505" + }, + { + "Key": "ServiceInstanceCount", + "Value": "1000" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-2.json index ab3ffc6a26f3..c02bd96ace75 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-2.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "MaxResults": 5, - "ContinuationToken": "PersistentQueueApp+2.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Name": "VolatileQueueApp", - "Version": "1.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "2.0", - "DefaultParameterList": [ - { - "Key": "MinReplicaSetSize", - "Value": "2" - }, - { - "Key": "TargetReplicaSetSize", - "Value": "3" - } - ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5, + "ContinuationToken": "PersistentQueueApp+2.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json index 123e89fa4520..47d3f9f6ee69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json @@ -1,61 +1,61 @@ -{ - "operationId": "GetApplicationTypeInfoList", - "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", - "parameters": { - "api-version": "6.0", - "ExcludeApplicationParameters": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Name": "CalculatorApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "CalculatorApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "GatewayApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "PersistentQueueApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "1.0", - "DefaultParameterList": [ ], - "Status": "Available" - }, - { - "Name": "VolatileQueueApp", - "Version": "2.0", - "DefaultParameterList": [ ], - "Status": "Available" - } - ] - } - } - } -} +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", + "parameters": { + "api-version": "6.0", + "ExcludeApplicationParameters": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationsEventList.json index f33d5314cd01..3e7ec703a345 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationsEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationsEventList.json @@ -1,37 +1,37 @@ -{ - "operationId": "GetApplicationsEventList", - "description": "This example shows how to get all applications-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App1Type", - "ApplicationTypeVersion": "1.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app1", - "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", - "TimeStamp": "2018-04-03T20:21:23.5774199Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ApplicationCreated", - "ApplicationTypeName": "App2Type", - "ApplicationTypeVersion": "4.0.1", - "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", - "ApplicationId": "app2", - "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3", - "TimeStamp": "2018-04-03T20:21:59.74842Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetApplicationsEventList", + "description": "This example shows how to get all applications-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App2Type", + "ApplicationTypeVersion": "4.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app2", + "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3", + "TimeStamp": "2018-04-03T20:21:59.74842Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyByName.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyByName.json index 84664d44b1d7..d48c65c8ed6a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyByName.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyByName.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetBackupPolicyByName", - "description": "This example shows how to query a backup policy by name.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - } - } +{ + "operationId": "GetBackupPolicyByName", + "description": "This example shows how to query a backup policy by name.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-1.json index a560bf05943e..b18863fab4d7 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-1.json @@ -1,54 +1,54 @@ -{ - "operationId": "GetBackupPolicyList", - "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "FileShare10MinBackupPolicy", - "Items": [ - { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - }, - { - "Name": "FileShare10MinBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT10M" - }, - "Storage": { - "StorageKind": "FileShare", - "FriendlyName": "FileShare_myshare", - "Path": "\\\\myshare\\backupshare", - "PrimaryUserName": "backupaccount", - "PrimaryPassword": "****" - } - } - ] - } - } - } -} +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "FileShare10MinBackupPolicy", + "Items": [ + { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + }, + { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "****" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-2.json index 8dd15c464676..3895a2315c81 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupPolicyList-2.json @@ -1,38 +1,38 @@ -{ - "operationId": "GetBackupPolicyList", - "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "ContinuationToken": "FileShare10MinBackupPolicy" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "AutoRestoreOnDataLoss": false, - "Name": "SampleBackupPolicy", - "MaxIncrementalBackups": 5, - "Schedule": { - "ScheduleKind": "FrequencyBased", - "Interval": "PT4H5M" - }, - "Storage": { - "Path": "\\\\myshare\\BackupStore", - "PrimaryUserName": "myuser1", - "PrimaryPassword": "****", - "SecondaryUserName": "myuser2", - "SecondaryPassword": "****", - "StorageKind": "FileShare", - "FriendlyName": "" - } - } - ] - } - } - } -} +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "ContinuationToken": "FileShare10MinBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "AutoRestoreOnDataLoss": false, + "Name": "SampleBackupPolicy", + "MaxIncrementalBackups": 5, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT4H5M" + }, + "Storage": { + "Path": "\\\\myshare\\BackupStore", + "PrimaryUserName": "myuser1", + "PrimaryPassword": "****", + "SecondaryUserName": "myuser2", + "SecondaryPassword": "****", + "StorageKind": "FileShare", + "FriendlyName": "" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-1.json index b49a069ce5a7..8b1acfc03d76 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-1.json @@ -1,72 +1,72 @@ -{ - "operationId": "GetBackupsFromBackupLocation", - "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "GetBackupByStorageQueryDescription": { - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupEntity": { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - } - } - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-2.json index d0dafc6acb99..b435bfc2fc58 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetBackupsFromBackupLocation-2.json @@ -1,73 +1,73 @@ -{ - "operationId": "GetBackupsFromBackupLocation", - "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "MaxResults": 2, - "GetBackupByStorageQueryDescription": { - "Storage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupEntity": { - "EntityKind": "Application", - "ApplicationName": "fabric:/CalcApp" - } - }, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + }, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetChaosEvents.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetChaosEvents.json index 4f0757539944..3a486b6fe298 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetChaosEvents.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetChaosEvents.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetChaosEvents", - "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.", - "parameters": { - "api-version": "6.2", - "StartTimeUtc": "0", - "EndTimeUtc": "3155378975999999999" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "History": [ - { - "ChaosEvent": { - "Kind": "Started", - "TimeStampUtc": "2017-04-14T04:27:19.049Z", - "ChaosParameters": { - "MaxClusterStabilizationTimeoutInSeconds": 30, - "MaxConcurrentFaults": 3, - "WaitTimeBetweenIterationsInSeconds": 10, - "WaitTimeBetweenFaultsInSeconds": 1, - "TimeToRunInSeconds": "3600", - "EnableMoveReplicaFaults": true, - "ClusterHealthPolicy": { - "ConsiderWarningAsError": true, - "MaxPercentUnhealthyNodes": 0, - "MaxPercentUnhealthyApplications": 10, - "ApplicationTypeHealthPolicyMap": [ - { - "Key": "myapp", - "Value": 3 - } - ] - }, - "Context": { - "Map": { - "k1": "v1", - "k2": "v2", - "k3": "v5" - } - } - } - } - }, - { - "ChaosEvent": { - "Kind": "ExecutingFaults", - "TimeStampUtc": "2017-04-14T04:27:20.667Z", - "Faults": [ - "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622", - "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.", - "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762" - ] - } - } - ] - } - } - } -} +{ + "operationId": "GetChaosEvents", + "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.", + "parameters": { + "api-version": "6.2", + "StartTimeUtc": "0", + "EndTimeUtc": "3155378975999999999" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "History": [ + { + "ChaosEvent": { + "Kind": "Started", + "TimeStampUtc": "2017-04-14T04:27:19.049Z", + "ChaosParameters": { + "MaxClusterStabilizationTimeoutInSeconds": 30, + "MaxConcurrentFaults": 3, + "WaitTimeBetweenIterationsInSeconds": 10, + "WaitTimeBetweenFaultsInSeconds": 1, + "TimeToRunInSeconds": "3600", + "EnableMoveReplicaFaults": true, + "ClusterHealthPolicy": { + "ConsiderWarningAsError": true, + "MaxPercentUnhealthyNodes": 0, + "MaxPercentUnhealthyApplications": 10, + "ApplicationTypeHealthPolicyMap": [ + { + "Key": "myapp", + "Value": 3 + } + ] + }, + "Context": { + "Map": { + "k1": "v1", + "k2": "v2", + "k3": "v5" + } + } + } + } + }, + { + "ChaosEvent": { + "Kind": "ExecutingFaults", + "TimeStampUtc": "2017-04-14T04:27:20.667Z", + "Faults": [ + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622", + "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.", + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetClusterEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetClusterEventList.json index 1367a2991cc3..b3eaef4069de 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetClusterEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetClusterEventList.json @@ -1,56 +1,56 @@ -{ - "operationId": "GetClusterEventList", - "description": "This example shows how to get all cluster-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ClusterUpgradeStart", - "CurrentClusterVersion": "0.0.0.0:", - "TargetClusterVersion": "6.2:1.0", - "UpgradeType": "Rolling", - "RollingUpgradeMode": "UnmonitoredAuto", - "FailureAction": "Manual", - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:18:59.4313064Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeDomainComplete", - "TargetClusterVersion": "6.2:1.0", - "UpgradeState": "RollingForward", - "UpgradeDomains": "(0 1 2)", - "UpgradeDomainElapsedTimeInMs": 78.5288, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:19:59.5729953Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeDomainComplete", - "TargetClusterVersion": "6.2:1.0", - "UpgradeState": "RollingForward", - "UpgradeDomains": "(3 4)", - "UpgradeDomainElapsedTimeInMs": 0.0, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:20:59.6271949Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ClusterUpgradeComplete", - "TargetClusterVersion": "6.2:1.0", - "OverallUpgradeElapsedTimeInMs": 120196.5212, - "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", - "TimeStamp": "2018-04-03T20:20:59.8134457Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetClusterEventList", + "description": "This example shows how to get all cluster-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ClusterUpgradeStart", + "CurrentClusterVersion": "0.0.0.0:", + "TargetClusterVersion": "6.2:1.0", + "UpgradeType": "Rolling", + "RollingUpgradeMode": "UnmonitoredAuto", + "FailureAction": "Manual", + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:18:59.4313064Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainComplete", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(0 1 2)", + "UpgradeDomainElapsedTimeInMs": 78.5288, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:19:59.5729953Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainComplete", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(3 4)", + "UpgradeDomainElapsedTimeInMs": 0.0, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.6271949Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeComplete", + "TargetClusterVersion": "6.2:1.0", + "OverallUpgradeElapsedTimeInMs": 120196.5212, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.8134457Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-1.json index 7dc4ab531340..49a23ee30dc4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-1.json @@ -1,20 +1,20 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "HTTP Server started listening on port 8080\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "HTTP Server started listening on port 8080\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-2.json index 14d00f2fbd60..0b1aec4546b8 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-2.json @@ -1,21 +1,21 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code", - "Tail": "10" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "UTC Time Now: 04\/02\/2018 22:06:31\r\nUTC Time Now: 04\/02\/2018 22:06:32\r\nUTC Time Now: 04\/02\/2018 22:06:33\r\nUTC Time Now: 04\/02\/2018 22:06:344\r\nUTC Time Now: 04\/02\/2018 22:06:35\r\nUTC Time Now: 04\/02\/2018 22:06:36\r\nUTC Time Now: 04\/02\/2018 22:06:37\r\nUTC Time Now: 04\/02\/2018 22:06:38\r\nUTC Time Now: 04\/02\/2018 22:06:39\r\nUTC Time Now: 04\/02\/2018 22:06:40\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Tail": "10" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "UTC Time Now: 04\/02\/2018 22:06:31\r\nUTC Time Now: 04\/02\/2018 22:06:32\r\nUTC Time Now: 04\/02\/2018 22:06:33\r\nUTC Time Now: 04\/02\/2018 22:06:344\r\nUTC Time Now: 04\/02\/2018 22:06:35\r\nUTC Time Now: 04\/02\/2018 22:06:36\r\nUTC Time Now: 04\/02\/2018 22:06:37\r\nUTC Time Now: 04\/02\/2018 22:06:38\r\nUTC Time Now: 04\/02\/2018 22:06:39\r\nUTC Time Now: 04\/02\/2018 22:06:40\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json index d188271fdf4f..5899e68003bc 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json @@ -1,21 +1,21 @@ -{ - "operationId": "GetContainerLogsDeployedOnNode", - "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.", - "parameters": { - "api-version": "6.2", - "nodeName": "_Node_0", - "applicationId": "SimpleHttpServerApp", - "ServiceManifestName": "SimpleHttpServerSvcPkg", - "CodePackageName": "Code", - "Previous": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n" - } - } - } +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Previous": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetCorrelatedEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetCorrelatedEventList.json index 30fc6a7b6b3b..95d5da39df42 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetCorrelatedEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetCorrelatedEventList.json @@ -1,31 +1,31 @@ -{ - "operationId": "GetCorrelatedEventList", - "description": "This example shows how to get all correlated events for a given eventInstanceId.", - "parameters": { - "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "Kind": "PartitionPrimaryMoveAnalysis", - "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z", - "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)", - "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)", - "MoveReason": "ApplicationHostDown", - "RelevantTraces": "", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963", - "TimeStamp": "2018-04-03T20:07:55.966073Z", - "HasCorrelatedEvents": true, - "Metadata": { - "Delay": "00:00:20", - "Duration": "00:01:59" - } - } - ] - } - } -} +{ + "operationId": "GetCorrelatedEventList", + "description": "This example shows how to get all correlated events for a given eventInstanceId.", + "parameters": { + "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "Kind": "PartitionPrimaryMoveAnalysis", + "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z", + "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)", + "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)", + "MoveReason": "ApplicationHostDown", + "RelevantTraces": "", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963", + "TimeStamp": "2018-04-03T20:07:55.966073Z", + "HasCorrelatedEvents": true, + "Metadata": { + "Delay": "00:00:20", + "Duration": "00:01:59" + } + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress-Running.json index a32244dcd235..c303852becce 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress-Running.json @@ -1,19 +1,19 @@ -{ - "operationId": "GetDataLossProgress", - "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress.json index 2a5854f737cd..429c33c8f7b6 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDataLossProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetDataLossProgress", - "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "InvokeDataLossResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeDataLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json index 954cf260b781..63cd97b83abe 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json @@ -1,29 +1,29 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "applicationId": "samples~CalculatorApp", - "IncludeHealthState": "true" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp", - "HealthState": "Ok" - } - }, - "204": { - "headers": {}, - "body": "" - } - } +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "applicationId": "samples~CalculatorApp", + "IncludeHealthState": "true" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + } + }, + "204": { + "headers": {}, + "body": "" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-1.json index f61fdb1b0967..452ac7b15380 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-1.json @@ -1,40 +1,40 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/samples/PQueueApp1", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", - "HealthState": "Unknown" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", - "HealthState": "Unknown" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Unknown" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-2.json index 3fda665b418c..4bdb8b879f78 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-2.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetDeployedApplicationInfoListByName", - "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "ContinuationToken": "fabric:/samples/PQueueApp1" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", - "HealthState": "Unknown" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoListByName", + "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json index a3b2da108c3a..dd387f2ea57e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetDeployedApplicationInfoList", - "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.", - "parameters": { - "api-version": "6.1", - "nodeName": "_Node_0", - "IncludeHealthState": "true" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Id": "samples~CalculatorApp", - "Name": "fabric:/samples/CalculatorApp", - "TypeName": "CalculatorApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", - "HealthState": "Ok" - }, - { - "Id": "samples~PQueueApp1", - "Name": "fabric:/samples/PQueueApp1", - "TypeName": "PersistentQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", - "HealthState": "Ok" - }, - { - "Id": "samples~VQueueApp1", - "Name": "fabric:/samples/VQueueApp1", - "TypeName": "VolatileQueueApp", - "Status": "Active", - "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", - "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", - "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", - "HealthState": "Ok" - } - ] - } - } - } -} +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "IncludeHealthState": "true" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Ok" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetFaultOperationList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetFaultOperationList.json index a1833242ccec..692f55108319 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetFaultOperationList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetFaultOperationList.json @@ -1,53 +1,53 @@ -{ - "operationId": "GetFaultOperationList", - "description": "This shows an example of possible output for GetFaultOperationList", - "parameters": { - "TypeFilter": "0xFF", - "StateFilter": "0xFF", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": - [ - { - "OperationId": "00000000-0000-0000-0000-000000000010", - "State": "Completed", - "Type": "PartitionDataLoss" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000020", - "State": "Completed", - "Type": "PartitionQuorumLoss" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000030", - "State": "Completed", - "Type": "PartitionRestart" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000500", - "State": "Faulted", - "Type": "NodeTransition" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000700", - "State": "Completed", - "Type": "NodeTransition" - }, - { - "OperationId": "00000000-0000-0000-0000-000000000710", - "State": "Completed", - "Type": "NodeTransition" - }, - { - "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a", - "State": "Completed", - "Type": "PartitionRestart" - } - ] - } - } -} +{ + "operationId": "GetFaultOperationList", + "description": "This shows an example of possible output for GetFaultOperationList", + "parameters": { + "TypeFilter": "0xFF", + "StateFilter": "0xFF", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": + [ + { + "OperationId": "00000000-0000-0000-0000-000000000010", + "State": "Completed", + "Type": "PartitionDataLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000020", + "State": "Completed", + "Type": "PartitionQuorumLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000030", + "State": "Completed", + "Type": "PartitionRestart" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000500", + "State": "Faulted", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000700", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000710", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a", + "State": "Completed", + "Type": "PartitionRestart" + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetImageStoreContent.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetImageStoreContent.json index 46e1abd19641..457cfd7986aa 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetImageStoreContent.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetImageStoreContent.json @@ -1,92 +1,92 @@ -{ - "operationId": "GetImageStoreContent", - "description": "This example shows how to get image store content under the given relative path.", - "parameters": { - "api-version": "6.2", - "contentPath": "Store\\CalcServiceApp" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "StoreFiles": [ - { - "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "23", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "897", - "ModifiedDate": "2017-09-28T17:44:22.609Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "25", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "26", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "27", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.468Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "19", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "744", - "ModifiedDate": "2017-09-28T17:44:22.578Z" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum", - "FileVersion": { - "EpochDataLossNumber": "131510254310497004", - "VersionNumber": "24", - "EpochConfigurationNumber": "25769803776" - }, - "FileSize": "66", - "ModifiedDate": "2017-09-28T17:44:22.484Z" - } - ], - "StoreFolders": [ - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0", - "FileCount": "2" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0", - "FileCount": "2" - }, - { - "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0", - "FileCount": "2" - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreContent", + "description": "This example shows how to get image store content under the given relative path.", + "parameters": { + "api-version": "6.2", + "contentPath": "Store\\CalcServiceApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "StoreFiles": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "23", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "897", + "ModifiedDate": "2017-09-28T17:44:22.609Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "25", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "26", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "27", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "19", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "744", + "ModifiedDate": "2017-09-28T17:44:22.578Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "24", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.484Z" + } + ], + "StoreFolders": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0", + "FileCount": "2" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeEventList.json index 5591529f395d..a21108addcbb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeEventList.json @@ -1,33 +1,33 @@ -{ - "operationId": "GetNodeEventList", - "description": "This example shows how to get all node-related events during a certain time window.", - "parameters": { - "nodeName": "node1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "NodeOpening", - "NodeInstance": 131672596159209215, - "NodeId": "ba001a8bb353543e646be031afb10f1e", - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "IpAddressOrFQDN": "100.78.240.56", - "Hostname": "RD0003FF5089AA", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node1", - "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", - "TimeStamp": "2018-04-03T20:06:55.966073Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetNodeEventList", + "description": "This example shows how to get all node-related events during a certain time window.", + "parameters": { + "nodeName": "node1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfo-1.json index 2b16e40bdac4..d812ecdef72a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfo-1.json @@ -1,44 +1,44 @@ -{ - "operationId": "GetNodeInfo", - "description": "This example shows how to get information about an node using it's identifier. If the node is found, information about it is returned with 200 status code. If the node is not found, empty content is returned with 204 status code.", - "parameters": { - "api-version": "6.0", - "nodeName": "_Node_1" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "Name": "_testnode_0", - "IpAddressOrFQDN": "10.0.0.4", - "Type": "testnode", - "CodeVersion": "6.3.139.9494", - "ConfigVersion": "5", - "NodeStatus": "Up", - "NodeUpTimeInSeconds": "18688", - "HealthState": "Ok", - "IsSeedNode": true, - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "Id": { - "Id": "2acb9f55540659b1c95f27cc128ab326" - }, - "InstanceId": "131738240209152398", - "NodeDeactivationInfo": { - "NodeDeactivationIntent": "Invalid", - "NodeDeactivationStatus": "None", - "NodeDeactivationTask": [], - "PendingSafetyChecks": [] - }, - "IsStopped": false, - "NodeDownTimeInSeconds": "0", - "NodeUpAt": "2018-06-18T19:33:52.944Z", - "NodeDownAt": "2018-06-18T19:33:39.514Z" - } - }, - "204": { - "headers": {}, - "body": "" - } - } -} +{ + "operationId": "GetNodeInfo", + "description": "This example shows how to get information about an node using it's identifier. If the node is found, information about it is returned with 200 status code. If the node is not found, empty content is returned with 204 status code.", + "parameters": { + "api-version": "6.0", + "nodeName": "_Node_1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Name": "_testnode_0", + "IpAddressOrFQDN": "10.0.0.4", + "Type": "testnode", + "CodeVersion": "6.3.139.9494", + "ConfigVersion": "5", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "18688", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "Id": { + "Id": "2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId": "131738240209152398", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-06-18T19:33:52.944Z", + "NodeDownAt": "2018-06-18T19:33:39.514Z" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-1.json index 5a54696257e9..be0a9a5d9509 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-1.json @@ -1,73 +1,73 @@ -{ - "operationId":"GetNodeInfoList", - "description":"This example shows how to get information about the nodes in the cluster when the number of results returned is limited by the MaxResults parameter.", - "parameters":{ - "api-version":"6.3", - "MaxResults":2 - }, - "responses":{ - "200":{ - "headers":{ - }, - "body":{ - "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326", - "Items":[ - { - "Name":"_testnode_1", - "IpAddressOrFQDN":"10.0.0.5", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"102016", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"1", - "FaultDomain":"fd:/1", - "Id":{ - "Id":"ebd986a1134b3643a8117fb41b259bf" - }, - "InstanceId":"131738274982501335", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T20:31:39.842Z", - "NodeDownAt":"2018-06-18T20:31:37.374Z" - }, - { - "Name":"_testnode_0", - "IpAddressOrFQDN":"10.0.0.4", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"105483", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"0", - "FaultDomain":"fd:/0", - "Id":{ - "Id":"2acb9f55540659b1c95f27cc128ab326" - }, - "InstanceId":"131738240209152398", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T19:33:52.944Z", - "NodeDownAt":"2018-06-18T19:33:39.514Z" - } - ] - } - } - } +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about the nodes in the cluster when the number of results returned is limited by the MaxResults parameter.", + "parameters":{ + "api-version":"6.3", + "MaxResults":2 + }, + "responses":{ + "200":{ + "headers":{ + }, + "body":{ + "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326", + "Items":[ + { + "Name":"_testnode_1", + "IpAddressOrFQDN":"10.0.0.5", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"102016", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"1", + "FaultDomain":"fd:/1", + "Id":{ + "Id":"ebd986a1134b3643a8117fb41b259bf" + }, + "InstanceId":"131738274982501335", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:31:39.842Z", + "NodeDownAt":"2018-06-18T20:31:37.374Z" + }, + { + "Name":"_testnode_0", + "IpAddressOrFQDN":"10.0.0.4", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"105483", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"0", + "FaultDomain":"fd:/0", + "Id":{ + "Id":"2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId":"131738240209152398", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:33:52.944Z", + "NodeDownAt":"2018-06-18T19:33:39.514Z" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-2.json index 2150bd646792..fb689851f34d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList-2.json @@ -1,100 +1,100 @@ -{ - "operationId":"GetNodeInfoList", - "description":"This example shows how to get information about nodes in the cluster which appear on a sequential page, by using the ContinuationToken parameter.", - "parameters":{ - "api-version":"6.3", - "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326" - }, - "responses":{ - "200":{ - "headers":{ - }, - "body":{ - "ContinuationToken":"", - "Items":[ - { - "Name":"_Node_4", - "IpAddressOrFQDN":"10.0.0.8", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"101547", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"4", - "FaultDomain":"fd:/4", - "Id":{ - "Id":"ba9383d728221add7fa996bf67b757fb" - }, - "InstanceId":"131737415865259763", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-17T20:40:07.378Z", - "NodeDownAt":"2018-06-17T20:33:11.877Z" - }, - { - "Name":"_Node_3", - "IpAddressOrFQDN":"10.0.0.7", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"15615", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"3", - "FaultDomain":"fd:/3", - "Id":{ - "Id":"d6a18a0935a3e39aeae2a049eb97255d" - }, - "InstanceId":"131738275300526952", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T20:32:18.884Z", - "NodeDownAt":"2018-06-18T20:31:59.128Z" - }, - { - "Name":"_Node_2", - "IpAddressOrFQDN":"10.0.0.6", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"19819", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"2", - "FaultDomain":"fd:/2", - "Id":{ - "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" - }, - "InstanceId":"131738233282843485", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T19:22:15.272Z", - "NodeDownAt":"2018-06-18T19:22:02.740Z" - } - ] - } - } - } +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about nodes in the cluster which appear on a sequential page, by using the ContinuationToken parameter.", + "parameters":{ + "api-version":"6.3", + "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326" + }, + "responses":{ + "200":{ + "headers":{ + }, + "body":{ + "ContinuationToken":"", + "Items":[ + { + "Name":"_Node_4", + "IpAddressOrFQDN":"10.0.0.8", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"101547", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"4", + "FaultDomain":"fd:/4", + "Id":{ + "Id":"ba9383d728221add7fa996bf67b757fb" + }, + "InstanceId":"131737415865259763", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-17T20:40:07.378Z", + "NodeDownAt":"2018-06-17T20:33:11.877Z" + }, + { + "Name":"_Node_3", + "IpAddressOrFQDN":"10.0.0.7", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15615", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"3", + "FaultDomain":"fd:/3", + "Id":{ + "Id":"d6a18a0935a3e39aeae2a049eb97255d" + }, + "InstanceId":"131738275300526952", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:32:18.884Z", + "NodeDownAt":"2018-06-18T20:31:59.128Z" + }, + { + "Name":"_Node_2", + "IpAddressOrFQDN":"10.0.0.6", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"19819", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"2", + "FaultDomain":"fd:/2", + "Id":{ + "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" + }, + "InstanceId":"131738233282843485", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:22:15.272Z", + "NodeDownAt":"2018-06-18T19:22:02.740Z" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList.json index 505a4f5e5e59..6e19eaa4d9a3 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeInfoList.json @@ -1,153 +1,153 @@ -{ - "operationId":"GetNodeInfoList", - "description":"This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.", - "parameters":{ - "api-version":"6.3" - }, - "responses":{ - "200":{ - "headers":{ - }, - "body":{ - "ContinuationToken":"", - "Items":[ - { - "Name":"_Node_1", - "IpAddressOrFQDN":"10.0.0.5", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"15275", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"1", - "FaultDomain":"fd:/1", - "Id":{ - "Id":"ebd986a1134b3643a8117fb41b259bf" - }, - "InstanceId":"131738274982501335", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T20:31:39.842Z", - "NodeDownAt":"2018-06-18T20:31:37.374Z" - }, - { - "Name":"_Node_0", - "IpAddressOrFQDN":"10.0.0.4", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"18742", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"0", - "FaultDomain":"fd:/0", - "Id":{ - "Id":"2acb9f55540659b1c95f27cc128ab326" - }, - "InstanceId":"131738240209152398", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T19:33:52.944Z", - "NodeDownAt":"2018-06-18T19:33:39.514Z" - }, - { - "Name":"_Node_4", - "IpAddressOrFQDN":"10.0.0.8", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"101168", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"4", - "FaultDomain":"fd:/4", - "Id":{ - "Id":"ba9383d728221add7fa996bf67b757fb" - }, - "InstanceId":"131737415865259763", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-17T20:40:07.378Z", - "NodeDownAt":"2018-06-17T20:33:11.877Z" - }, - { - "Name":"_Node_3", - "IpAddressOrFQDN":"10.0.0.7", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"15236", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"3", - "FaultDomain":"fd:/3", - "Id":{ - "Id":"d6a18a0935a3e39aeae2a049eb97255d" - }, - "InstanceId":"131738275300526952", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T20:32:18.884Z", - "NodeDownAt":"2018-06-18T20:31:59.128Z" - }, - { - "Name":"_Node_2", - "IpAddressOrFQDN":"10.0.0.6", - "Type":"testnode", - "CodeVersion":"6.3.139.9494", - "ConfigVersion":"5", - "NodeStatus":"Up", - "NodeUpTimeInSeconds":"19440", - "HealthState":"Ok", - "IsSeedNode":true, - "UpgradeDomain":"2", - "FaultDomain":"fd:/2", - "Id":{ - "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" - }, - "InstanceId":"131738233282843485", - "NodeDeactivationInfo":{ - "NodeDeactivationIntent":"Invalid", - "NodeDeactivationStatus":"None", - "NodeDeactivationTask":[], - "PendingSafetyChecks":[] - }, - "IsStopped":false, - "NodeDownTimeInSeconds":"0", - "NodeUpAt":"2018-06-18T19:22:15.272Z", - "NodeDownAt":"2018-06-18T19:22:02.740Z" - } - ] - } - } - } +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.", + "parameters":{ + "api-version":"6.3" + }, + "responses":{ + "200":{ + "headers":{ + }, + "body":{ + "ContinuationToken":"", + "Items":[ + { + "Name":"_Node_1", + "IpAddressOrFQDN":"10.0.0.5", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15275", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"1", + "FaultDomain":"fd:/1", + "Id":{ + "Id":"ebd986a1134b3643a8117fb41b259bf" + }, + "InstanceId":"131738274982501335", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:31:39.842Z", + "NodeDownAt":"2018-06-18T20:31:37.374Z" + }, + { + "Name":"_Node_0", + "IpAddressOrFQDN":"10.0.0.4", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"18742", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"0", + "FaultDomain":"fd:/0", + "Id":{ + "Id":"2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId":"131738240209152398", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:33:52.944Z", + "NodeDownAt":"2018-06-18T19:33:39.514Z" + }, + { + "Name":"_Node_4", + "IpAddressOrFQDN":"10.0.0.8", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"101168", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"4", + "FaultDomain":"fd:/4", + "Id":{ + "Id":"ba9383d728221add7fa996bf67b757fb" + }, + "InstanceId":"131737415865259763", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-17T20:40:07.378Z", + "NodeDownAt":"2018-06-17T20:33:11.877Z" + }, + { + "Name":"_Node_3", + "IpAddressOrFQDN":"10.0.0.7", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15236", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"3", + "FaultDomain":"fd:/3", + "Id":{ + "Id":"d6a18a0935a3e39aeae2a049eb97255d" + }, + "InstanceId":"131738275300526952", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:32:18.884Z", + "NodeDownAt":"2018-06-18T20:31:59.128Z" + }, + { + "Name":"_Node_2", + "IpAddressOrFQDN":"10.0.0.6", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"19440", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"2", + "FaultDomain":"fd:/2", + "Id":{ + "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" + }, + "InstanceId":"131738233282843485", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:22:15.272Z", + "NodeDownAt":"2018-06-18T19:22:02.740Z" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress-Running.json index 901902f2ce40..64d4642700ea 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress-Running.json @@ -1,18 +1,18 @@ -{ - "operationId": "GetNodeTransitionProgress", - "description": "This shows an example of output when GetTransitionProgress has a State of Running.", - "parameters": { - "nodeName": "N0060", - "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of output when GetTransitionProgress has a State of Running.", + "parameters": { + "nodeName": "N0060", + "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress.json index 28a337aa3685..5ee8818ce76a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodeTransitionProgress.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetNodeTransitionProgress", - "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "nodeName": "N0060", - "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "NodeTransitionResult": { - "ErrorCode": 0, - "NodeResult": { - "NodeName": "N0060", - "NodeInstanceId": "131366982707950527" - } - } - } - } - } +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "nodeName": "N0060", + "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "NodeTransitionResult": { + "ErrorCode": 0, + "NodeResult": { + "NodeName": "N0060", + "NodeInstanceId": "131366982707950527" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodesEventList.json index 11cc67a0cc66..aae5dea1cc1c 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodesEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetNodesEventList.json @@ -1,47 +1,47 @@ -{ - "operationId": "GetNodesEventList", - "description": "This example shows how to get all nodes-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "NodeOpening", - "NodeInstance": 131672596159209215, - "NodeId": "ba001a8bb353543e646be031afb10f1e", - "UpgradeDomain": "0", - "FaultDomain": "fd:/0", - "IpAddressOrFQDN": "100.78.240.56", - "Hostname": "RD0003FF5089AA", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node1", - "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", - "TimeStamp": "2018-04-03T20:06:55.966073Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "NodeOpening", - "NodeInstance": 131672596186027906, - "NodeId": "ba03ef91259835c54d674889849a7cee", - "UpgradeDomain": "3", - "FaultDomain": "fd:/3", - "IpAddressOrFQDN": "100.72.76.122", - "Hostname": "RD0003FF6047A8", - "IsSeedNode": false, - "NodeVersion": "6.2:1.0", - "NodeName": "node2", - "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0", - "TimeStamp": "2018-04-03T20:06:58.6357365Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetNodesEventList", + "description": "This example shows how to get all nodes-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpening", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "NodeOpening", + "NodeInstance": 131672596186027906, + "NodeId": "ba03ef91259835c54d674889849a7cee", + "UpgradeDomain": "3", + "FaultDomain": "fd:/3", + "IpAddressOrFQDN": "100.72.76.122", + "Hostname": "RD0003FF6047A8", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node2", + "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0", + "TimeStamp": "2018-04-03T20:06:58.6357365Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupConfigurationInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupConfigurationInfo.json index 6784ad061fcd..48ffda64fa66 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupConfigurationInfo.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupConfigurationInfo.json @@ -1,25 +1,25 @@ -{ - "operationId": "GetPartitionBackupConfigurationInfo", - "description": "This example shows how to get backup configuration for a partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Service", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - } - } -} +{ + "operationId": "GetPartitionBackupConfigurationInfo", + "description": "This example shows how to get backup configuration for a partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-1.json index 50a5c0bedd52..95228d16752f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-1.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-2.json index 20e3c2e5fcbb..a8b808b8db3d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-2.json @@ -1,41 +1,41 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get the latest backup for the specified partition.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", - "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "639", - "CreationTimeUtc": "2018-01-02T08:59:53Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get the latest backup for the specified partition.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-3.json index e934056ddad7..607b42eaa2cb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-4.json index 5487bb20b6cb..0444cd5e8266 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupList-4.json @@ -1,42 +1,42 @@ -{ - "operationId": "GetPartitionBackupList", - "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", - "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "639", - "CreationTimeUtc": "2018-01-02T08:59:53Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupProgress.json index 82f5824542da..9e0b2545db60 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionBackupProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetPartitionBackupProgress", - "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.", - "parameters": { - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "BackupState": "Success", - "TimeStampUtc": "2018-01-01T09:00:55Z", - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "FailureError": null - } - } - } +{ + "operationId": "GetPartitionBackupProgress", + "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "BackupState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "FailureError": null + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionEventList.json index 744cc49add28..aae33c4b1e00 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionEventList.json @@ -1,38 +1,38 @@ -{ - "operationId": "GetPartitionEventList", - "description": "This example shows how to get all partition-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node1", - "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934595, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 203.1935, - "Phase3DurationMs": 0.0262, - "Phase4DurationMs": 628.8527, - "TotalDurationMs": 832.0724, - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "TimeStamp": "2018-04-03T20:21:47.3778996Z", - "HasCorrelatedEvents": true - } - ] - } - } -} +{ + "operationId": "GetPartitionEventList", + "description": "This example shows how to get all partition-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestartProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestartProgress.json index 7cc25203d70e..4453caa242d6 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestartProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestartProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetPartitionRestartProgress", - "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "RestartPartitionResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetPartitionRestartProgress", + "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "RestartPartitionResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestoreProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestoreProgress.json index 0d10b95e96ed..cd6099ad4d61 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestoreProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionRestoreProgress.json @@ -1,24 +1,24 @@ -{ - "operationId": "GetPartitionRestoreProgress", - "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.", - "parameters": { - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "api-version": "6.2-preview" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "RestoreState": "Success", - "TimeStampUtc": "2018-01-01T09:00:55Z", - "RestoredEpoch": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "RestoredLsn": "261", - "FailureError": null - } - } - } +{ + "operationId": "GetPartitionRestoreProgress", + "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.2-preview" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "RestoreState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "RestoredEpoch": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "RestoredLsn": "261", + "FailureError": null + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionsEventList.json index 201708dd62d1..dd7f4311823f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionsEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPartitionsEventList.json @@ -1,57 +1,57 @@ -{ - "operationId": "GetPartitionsEventList", - "description": "This example shows how to get all partitions-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node1", - "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934595, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 203.1935, - "Phase3DurationMs": 0.0262, - "Phase4DurationMs": 628.8527, - "TotalDurationMs": 832.0724, - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", - "TimeStamp": "2018-04-03T20:21:47.3778996Z", - "HasCorrelatedEvents": true - }, - { - "Kind": "PartitionReconfigurationCompleted", - "NodeName": "node2", - "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb", - "ServiceType": "Svc1Type", - "CcEpochDataLossVersion": 131672604833413107, - "CcEpochConfigVersion": 8589934596, - "ReconfigType": "Other", - "Result": "Completed", - "Phase0DurationMs": 0.0, - "Phase1DurationMs": 0.0, - "Phase2DurationMs": 205.667, - "Phase3DurationMs": 407.7781, - "Phase4DurationMs": 630.0935, - "TotalDurationMs": 1243.5386, - "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec", - "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86", - "TimeStamp": "2018-04-03T20:21:49.5155104Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionsEventList", + "description": "This example shows how to get all partitions-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + }, + { + "Kind": "PartitionReconfigurationCompleted", + "NodeName": "node2", + "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934596, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 205.667, + "Phase3DurationMs": 407.7781, + "Phase4DurationMs": 630.0935, + "TotalDurationMs": 1243.5386, + "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec", + "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86", + "TimeStamp": "2018-04-03T20:21:49.5155104Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfo-1.json index 74665c5ff263..fd0e63e316bf 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfo-1.json @@ -1,30 +1,30 @@ -{ - "operationId": "GetPropertyInfo", - "description": "This example shows how to get a Service Fabric property under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "PropertyName": "AppData" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Name": "CalculatorAppData", - "Value": { - "Kind": "String", - "Data": "1+2=3" - }, - "Metadata": { - "TypeId": "String", - "CustomTypeId": "EquationType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 12, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "12" - } - } - } - } -} +{ + "operationId": "GetPropertyInfo", + "description": "This example shows how to get a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyName": "AppData" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "CalculatorAppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "Metadata": { + "TypeId": "String", + "CustomTypeId": "EquationType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 12, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "12" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-1.json index de3586fa9946..9d4f74b46e80 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-1.json @@ -1,43 +1,43 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to get all Service Fabric properties under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueAppData$131439231986491349", - "IsConsistent": true, - "Properties": [ - { - "Name": "CalculatorAppData", - "Metadata": { - "TypeId": "Int64", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "10" - } - }, - { - "Name": "PersistentQueueAppData", - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationDataType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", - "SequenceNumber": "12" - } - } - ] - - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-2.json index 1475549419ca..405aeca605ff 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-2.json @@ -1,51 +1,51 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to get all Service Fabric properties and their values under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "IncludeValues": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "PersistentQueueAppData$131439231986491349", - "IsConsistent": true, - "Properties": [ - { - "Name": "CalculatorAppData", - "Value": { - "Kind": "Int64", - "Data": "4534" - }, - "Metadata": { - "TypeId": "Int64", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 8, - "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", - "SequenceNumber": "10" - } - }, - { - "Name": "PersistentQueueAppData", - "Value": { - "Kind": "Binary", - "Data": [6, 7, 8, 9, 10] - }, - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationDataType", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", - "SequenceNumber": "12" - } - } - ] - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties and their values under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Value": { + "Kind": "Int64", + "Data": "4534" + }, + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [6, 7, 8, 9, 10] + }, + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-3.json index ed04219db38f..51a4fcb919b4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetPropertyInfoList-3.json @@ -1,37 +1,37 @@ -{ - "operationId": "GetPropertyInfoList", - "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "IncludeValues": true, - "ContinuationToken": "PersistentQueueAppData$131439231986491349" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "Properties": [ - { - "Name": "VolatileQueueAppData", - "Value": { - "Kind": "Double", - "Data": 67.89 - }, - "Metadata": { - "TypeId": "Double", - "CustomTypeId": "", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 8, - "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z", - "SequenceNumber": "8" - } - } - ] - } - } - } -} +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true, + "ContinuationToken": "PersistentQueueAppData$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "Properties": [ + { + "Name": "VolatileQueueAppData", + "Value": { + "Kind": "Double", + "Data": 67.89 + }, + "Metadata": { + "TypeId": "Double", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z", + "SequenceNumber": "8" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress-Running.json index 9789fb25cd70..059c51840fc9 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress-Running.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress-Running.json @@ -1,19 +1,19 @@ -{ - "operationId": "GetQuorumLossProgress", - "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Running" - } - } - } +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress.json index 9c2391300712..3e848d89bc8d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetQuorumLossProgress.json @@ -1,26 +1,26 @@ -{ - "operationId": "GetQuorumLossProgress", - "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", - "parameters": { - "serviceId": "fabric:/myapp/myservice", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", - "api-version": "6.0" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "State": "Completed", - "InvokeQuorumLossResult": { - "ErrorCode": 0, - "SelectedPartition": { - "ServiceName": "fabric:/myapp/myservice", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - } - } - } - } - } +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeQuorumLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicaEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicaEventList.json index b9a1f76bc1a6..a89b8578ab44 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicaEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicaEventList.json @@ -1,36 +1,36 @@ -{ - "operationId": "GetPartitionReplicaEventList", - "description": "This example shows how to get all replica-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "replicaId": 131672608994209130, - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 131672608994209130, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677787, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:43:38Z", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "ReplicaId": 131672608994209130, - "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", - "TimeStamp": "2018-04-03T21:43:38.8904013Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionReplicaEventList", + "description": "This example shows how to get all replica-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "replicaId": 131672608994209130, + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicasEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicasEventList.json index 54dd7db48b5f..793b6d201db5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicasEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetReplicasEventList.json @@ -1,52 +1,52 @@ -{ - "operationId": "GetPartitionReplicasEventList", - "description": "This example shows how to get all replicas-related events during a certain time window.", - "parameters": { - "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 131672608994209130, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677787, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:43:38Z", - "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", - "ReplicaId": 131672608994209130, - "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", - "TimeStamp": "2018-04-03T21:43:38.8904013Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "StatefulReplicaHealthReportCreated", - "ReplicaInstanceId": 177872608994339550, - "SourceId": "TestSource", - "Property": "", - "HealthState": "Error", - "TimeToLiveMs": 922337203685477, - "SequenceNumber": 131672654189677788, - "Description": "", - "RemoveWhenExpired": false, - "SourceUtcTimestamp": "2018-04-03T21:44:38Z", - "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef", - "ReplicaId": 177872608994339550, - "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350", - "TimeStamp": "2018-04-03T21:44:38.8904013Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetPartitionReplicasEventList", + "description": "This example shows how to get all replicas-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "StatefulReplicaHealthReportCreated", + "ReplicaInstanceId": 177872608994339550, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677788, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:44:38Z", + "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef", + "ReplicaId": 177872608994339550, + "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350", + "TimeStamp": "2018-04-03T21:44:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-1.json index 438c3e22786d..9e7a54d9b89f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-1.json @@ -1,41 +1,41 @@ -{ - "operationId": "GetServiceBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "Items": [ - { - "Kind": "Service", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ServiceName": "fabric:/CalcApp/CalcService", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - }, - { - "Kind": "Partition", - "PolicyName": "BackupPolicy2", - "PolicyInheritedFrom": "Partition", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "SuspensionInfo": { - "IsSuspended": false, - "SuspensionInheritedFrom": "Invalid" - } - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Items": [ + { + "Kind": "Service", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Partition", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-2.json index 321e25402e72..126c01ad5d60 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupConfigurationInfo-2.json @@ -1,32 +1,32 @@ -{ - "operationId": "GetServiceBackupConfigurationInfo", - "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "Kind": "Partition", - "PolicyName": "BackupPolicy1", - "PolicyInheritedFrom": "Application", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6", - "SuspensionInfo": { - "IsSuspended": true, - "SuspensionInheritedFrom": "Partition" - } - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-1.json index d0ab2108240f..cb0c6c85b6a5 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-1.json @@ -1,105 +1,105 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups within a time range.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "StartDateTimeFilter": "2018-01-01T00:00:00Z", - "EndDateTimeFilter": "2018-01-01T23:59:59Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups within a time range.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-2.json index 3326573cc921..03d20cfcca7e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-2.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get the latest backup for each partition within a service.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "Latest": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get the latest backup for each partition within a service.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-3.json index ff0fe9ea7c3e..3e0d3827a229 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-3.json @@ -1,62 +1,62 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2 - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "Items": [ - { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "261", - "CreationTimeUtc": "2018-01-01T09:00:55Z", - "FailureError": null - }, - { - "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", - "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "446", - "CreationTimeUtc": "2018-01-01T17:01:02Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-4.json index 28dbfc7c2fa0..15482f3db270 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceBackupList-4.json @@ -1,63 +1,63 @@ -{ - "operationId": "GetServiceBackupList", - "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService", - "MaxResults": 2, - "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "Items": [ - { - "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", - "BackupType": "Full", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "161", - "CreationTimeUtc": "2018-01-01T09:01:02Z", - "FailureError": null - }, - { - "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", - "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", - "ApplicationName": "fabric:/CalcApp", - "ServiceName": "fabric:/CalcApp/CalcService", - "PartitionInformation": { - "LowKey": "-9223372036854775808", - "HighKey": "9223372036854775807", - "ServicePartitionKind": "Int64Range", - "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" - }, - "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", - "BackupType": "Incremental", - "EpochOfLastBackupRecord": { - "DataLossNumber": "131462452931584510", - "ConfigurationNumber": "8589934592" - }, - "LsnOfLastBackupRecord": "246", - "CreationTimeUtc": "2018-01-01T17:00:34Z", - "FailureError": null - } - ] - } - } - } -} +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossNumber": "131462452931584510", + "ConfigurationNumber": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceEventList.json index 04241407ef2c..ae7adcc98ecf 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceEventList.json @@ -1,35 +1,35 @@ -{ - "operationId": "GetServiceEventList", - "description": "This example shows how to get all service-related events during a certain time window.", - "parameters": { - "serviceId": "app1~svc1", - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc1Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", - "ServiceId": "app1/svc1", - "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", - "TimeStamp": "2018-04-03T20:22:38.0560496Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetServiceEventList", + "description": "This example shows how to get all service-related events during a certain time window.", + "parameters": { + "serviceId": "app1~svc1", + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json index 617b06fe7e3e..092ac09a733e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json @@ -1,39 +1,39 @@ -{ - "operationId": "GetServiceTypeInfoByName", - "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", - "parameters": { - "api-version": "6.0", - "applicationTypeName": "Application2Type", - "ApplicationTypeVersion": "1.0.0", - "serviceTypeName": "Actor1ActorServiceType" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ServiceTypeDescription": { - "IsStateful": true, - "ServiceTypeName": "Actor1ActorServiceType", - "PlacementConstraints": "", - "HasPersistedState": true, - "Kind": "Stateful", - "Extensions": [ - { - "Key": "__GeneratedServiceType__", - "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " - } - ], - "LoadMetrics": [], - "ServicePlacementPolicies": [] - }, - "ServiceManifestVersion": "1.0.0", - "ServiceManifestName": "Actor1Pkg", - "IsServiceGroup": false - } - }, - "204": { - "headers": {}, - "body": "" - } - } -} +{ + "operationId": "GetServiceTypeInfoByName", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0", + "serviceTypeName": "Actor1ActorServiceType" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoList-1.json index ccc292e62e0c..a4481bfa08c0 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoList-1.json @@ -1,36 +1,36 @@ -{ - "operationId": "GetServiceTypeInfoList", - "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.", - "parameters": { - "api-version": "6.0", - "applicationTypeName": "Application2Type", - "ApplicationTypeVersion": "1.0.0" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "ServiceTypeDescription": { - "IsStateful": true, - "ServiceTypeName": "Actor1ActorServiceType", - "PlacementConstraints": "", - "HasPersistedState": true, - "Kind": "Stateful", - "Extensions": [ - { - "Key": "__GeneratedServiceType__", - "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " - } - ], - "LoadMetrics": [], - "ServicePlacementPolicies": [] - }, - "ServiceManifestVersion": "1.0.0", - "ServiceManifestName": "Actor1Pkg", - "IsServiceGroup": false - } - ] - } - } -} +{ + "operationId": "GetServiceTypeInfoList", + "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServicesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServicesEventList.json index 7a4c570cf344..bd4b7353165e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServicesEventList.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServicesEventList.json @@ -1,51 +1,51 @@ -{ - "operationId": "GetServicesEventList", - "description": "This example shows how to get all services-related events during a certain time window.", - "parameters": { - "api-version": "6.2-preview", - "StartTimeUtc": "2018-04-03T18:00:00Z", - "EndTimeUtc": "2018-04-04T18:00:00Z" - }, - "responses": { - "200": { - "headers": { - }, - "body": [ - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc1Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", - "ServiceId": "app1/svc1", - "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", - "TimeStamp": "2018-04-03T20:22:38.0560496Z", - "HasCorrelatedEvents": false - }, - { - "Kind": "ServiceCreated", - "ServiceTypeName": "Svc2Type", - "ApplicationName": "fabric:/app1", - "ApplicationTypeName": "App1Type", - "ServiceInstance": 131672605579916062, - "IsStateful": true, - "PartitionCount": 2, - "TargetReplicaSetSize": 3, - "MinReplicaSetSize": 2, - "ServicePackageVersion": "1.0:1.0", - "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3", - "ServiceId": "app1/svc2", - "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318", - "TimeStamp": "2018-04-03T20:22:38.056197Z", - "HasCorrelatedEvents": false - } - ] - } - } -} +{ + "operationId": "GetServicesEventList", + "description": "This example shows how to get all services-related events during a certain time window.", + "parameters": { + "api-version": "6.2-preview", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc2Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3", + "ServiceId": "app1/svc2", + "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318", + "TimeStamp": "2018-04-03T20:22:38.056197Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-1.json index d2aad11d56b1..3d315a557a9f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-1.json @@ -1,22 +1,22 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to get information about all sub names of a given Service Fabric name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/CalculatorApp", - "fabric:/samples/mynames" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to get information about all sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/CalculatorApp", + "fabric:/samples/mynames" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-2.json index 441fa7ea5da7..6dbd9309980a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-2.json @@ -1,28 +1,28 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples", - "Recursive": true - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/apps", - "fabric:/samples/data", - "fabric:/samples/CalculatorApp", - "fabric:/samples/CalculatorApp/CalculatorService", - "fabric:/samples/CalculatorApp/CalculatorService/Name-1", - "fabric:/samples/CalculatorApp/CalculatorService/Name-2", - "fabric:/samples/mynames/name-1" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps", + "fabric:/samples/data", + "fabric:/samples/CalculatorApp", + "fabric:/samples/CalculatorApp/CalculatorService", + "fabric:/samples/CalculatorApp/CalculatorService/Name-1", + "fabric:/samples/CalculatorApp/CalculatorService/Name-2", + "fabric:/samples/mynames/name-1" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-3.json index 661dbcc22deb..3265fc8a3c13 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetSubNameInfoList-3.json @@ -1,24 +1,24 @@ -{ - "operationId": "GetSubNameInfoList", - "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", - "parameters": { - "api-version": "6.0", - "nameId": "samples", - "Recursive": true, - "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "ContinuationToken": "", - "IsConsistent": true, - "SubNames": [ - "fabric:/samples/apps/VolatileQueueApp", - "fabric:/samples/apps/NotepadApp" - ] - } - } - } -} +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true, + "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps/VolatileQueueApp", + "fabric:/samples/apps/NotepadApp" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionById.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionById.json index 2cee9beefa54..21ce39b90dd9 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionById.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionById.json @@ -1,34 +1,34 @@ -{ - "operationId": "GetImageStoreUploadSessionById", - "description": "This example shows how to get image store upload session by a given ID.", - "parameters": { - "api-version": "6.0", - "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "UploadSessions": [ - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:06:37.260Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "402128" - }, - { - "StartPosition": "730105", - "EndPosition": "2097151" - } - ] - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreUploadSessionById", + "description": "This example shows how to get image store upload session by a given ID.", + "parameters": { + "api-version": "6.0", + "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:06:37.260Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "402128" + }, + { + "StartPosition": "730105", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionByPath.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionByPath.json index 5f5ad736f03e..82743551c7cb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionByPath.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetUploadSessionByPath.json @@ -1,50 +1,50 @@ -{ - "operationId": "GetImageStoreUploadSessionByPath", - "description": "This example shows how to get image store upload session by a given relative path.", - "parameters": { - "api-version": "6.0", - "contentPath": "SwaggerTest\\Common.dll" - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "UploadSessions": [ - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:28:11.627Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "207615" - }, - { - "StartPosition": "626977", - "EndPosition": "2097151" - } - ] - }, - { - "StoreRelativePath": "SwaggerTest\\Common.dll", - "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5", - "FileSize": "2097152", - "ModifiedDate": "2017-09-28T17:28:11.643Z", - "ExpectedRanges": [ - { - "StartPosition": "0", - "EndPosition": "616947" - }, - { - "StartPosition": "1087529", - "EndPosition": "2097151" - } - ] - } - ] - } - } - } -} +{ + "operationId": "GetImageStoreUploadSessionByPath", + "description": "This example shows how to get image store upload session by a given relative path.", + "parameters": { + "api-version": "6.0", + "contentPath": "SwaggerTest\\Common.dll" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.627Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "207615" + }, + { + "StartPosition": "626977", + "EndPosition": "2097151" + } + ] + }, + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.643Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "616947" + }, + { + "StartPosition": "1087529", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi.json index bb4610ae2e2d..cdaf407acf69 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi.json @@ -1,27 +1,27 @@ -{ - "operationId": "InvokeContainerApi", - "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.", - "parameters": { - "api-version": "6.2", - "nodeName": "Node01", - "applicationId": "samples/winnodejs", - "ServiceManifestName": "NodeServicePackage", - "CodePackageName": "NodeService.Code", - "CodePackageInstanceId": "131668159770315380", - "ContainerApiRequestBody": { - "UriPath": "/containers/{id}/logs?stdout=true&stderr=true" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ContainerApiResult": { - "Status": 200, - "Content-Type": "text/plain; charset=utf-8", - "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n" - } - } - } - } +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "Node01", + "applicationId": "samples/winnodejs", + "ServiceManifestName": "NodeServicePackage", + "CodePackageName": "NodeService.Code", + "CodePackageInstanceId": "131668159770315380", + "ContainerApiRequestBody": { + "UriPath": "/containers/{id}/logs?stdout=true&stderr=true" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "text/plain; charset=utf-8", + "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi_Post.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi_Post.json index dfbdcf541aef..1af58111eb46 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi_Post.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/InvokeContainerApi_Post.json @@ -1,29 +1,29 @@ -{ - "operationId": "InvokeContainerApi", - "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.", - "parameters": { - "api-version": "6.2", - "nodeName": "N0020", - "applicationId": "samples/nodejs1", - "ServiceManifestName": "NodeOnSF", - "CodePackageName": "Code", - "CodePackageInstanceId": "131673596679688285", - "ContainerApiRequestBody": { - "HttpVerb": "POST", - "UriPath": "/containers/{id}/update", - "Body": "{ \"CpuShares\": 512}" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "ContainerApiResult": { - "Status": 200, - "Content-Type": "application/json", - "Body": "{\"Warnings\":null}\n" - } - } - } - } +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "N0020", + "applicationId": "samples/nodejs1", + "ServiceManifestName": "NodeOnSF", + "CodePackageName": "Code", + "CodePackageInstanceId": "131673596679688285", + "ContainerApiRequestBody": { + "HttpVerb": "POST", + "UriPath": "/containers/{id}/update", + "Body": "{ \"CpuShares\": 512}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "application/json", + "Body": "{\"Warnings\":null}\n" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-1.json index 511aa04cf3ed..f2e3d3252d09 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-1.json @@ -1,19 +1,19 @@ -{ - "operationId": "PutProperty", - "description": "This example shows how to create or update a Service Fabric property under a given name.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps/CalculatorApp", - "PropertyDescription": { - "PropertyName": "AppData", - "Value": { - "Kind": "Binary", - "Data": [0, 1, 2, 3, 4, 5] - } - } - }, - "responses": { - "200": { - } - } -} +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "Binary", + "Data": [0, 1, 2, 3, 4, 5] + } + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-2.json index 1d597a75d6c0..85713723d090 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/PutProperty-2.json @@ -1,20 +1,20 @@ -{ - "operationId": "PutProperty", - "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps/CalculatorApp", - "PropertyDescription": { - "PropertyName": "AppData", - "Value": { - "Kind": "String", - "Data": "1+2=3" - }, - "CustomTypeId": "EquationType" - } - }, - "responses": { - "200": { - } - } -} +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "CustomTypeId": "EquationType" + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateApplicationResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateApplicationResource.json index 25ab95db6fef..3450bd4503a7 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateApplicationResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateApplicationResource.json @@ -1,46 +1,46 @@ -{ - "operationId": "CreateApplicationResource", - "description": "This example shows how to create or update an application resource.", - "parameters": { - "applicationResourceName": "helloWorldApp", - "api-version": "6.3-preview", - "applicationResourceDescription": { - "name": "helloWorldApp", - "properties": { - "description": "SeaBreeze HelloWorld Application!", - "services": [ - { - "name": "helloWorldService", - "properties": { - "description": "SeaBreeze Hello World Service.", - "osType": "linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "replicaCount": 1 - } - } - ] - } - } - }, - "responses": { - "201": {}, - "202": {} - } +{ + "operationId": "CreateApplicationResource", + "description": "This example shows how to create or update an application resource.", + "parameters": { + "applicationResourceName": "helloWorldApp", + "api-version": "6.3-preview", + "applicationResourceDescription": { + "name": "helloWorldApp", + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "services": [ + { + "name": "helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "replicaCount": 1 + } + } + ] + } + } + }, + "responses": { + "201": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateVolumeResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateVolumeResource.json index 8181c7542fe5..d447312a9818 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateVolumeResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/CreateOrUpdateVolumeResource.json @@ -1,24 +1,24 @@ -{ - "operationId": "CreateVolumeResource", - "description": "This example shows how to create or update an volume resource.", - "parameters": { - "api-version": "6.3-preview", - "volumeResourceName": "meshDemoVolume", - "volumeResourceDescription": { - "volumeResourceName": "meshDemoVolume", - "properties": { - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "accountKey": "provide-account-key-here", - "shareName": "sharel" - } - } - } - }, - "responses": { - "201": {}, - "202": {} - } +{ + "operationId": "CreateVolumeResource", + "description": "This example shows how to create or update an volume resource.", + "parameters": { + "api-version": "6.3-preview", + "volumeResourceName": "meshDemoVolume", + "volumeResourceDescription": { + "volumeResourceName": "meshDemoVolume", + "properties": { + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + } + } + } + }, + "responses": { + "201": {}, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteApplicationResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteApplicationResource.json index b2cf917d7356..4b2156c02a4e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteApplicationResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteApplicationResource.json @@ -1,13 +1,13 @@ -{ - "operationId": "DeleteApplicationResource", - "description": "This example shows how to delete an existing application resource. If the application resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "applicationResourceName": "helloWorldApp", - "api-version": "6.3-preview" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } +{ + "operationId": "DeleteApplicationResource", + "description": "This example shows how to delete an existing application resource. If the application resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "applicationResourceName": "helloWorldApp", + "api-version": "6.3-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteVolumeResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteVolumeResource.json index 9a7fb9b81228..f981f61405f9 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteVolumeResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/DeleteVolumeResource.json @@ -1,13 +1,13 @@ -{ - "operationId": "DeleteVolumeResource", - "description": "This example shows how to delete an existing volume resource. If the volume resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "volumeResourceName": "meshDemoVolume", - "api-version": "6.3-preview" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } +{ + "operationId": "DeleteVolumeResource", + "description": "This example shows how to delete an existing volume resource. If the volume resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "volumeResourceName": "meshDemoVolume", + "api-version": "6.3-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetApplicationResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetApplicationResource.json index eb9b3b98057e..e36748d07114 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetApplicationResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetApplicationResource.json @@ -1,23 +1,23 @@ -{ - "operationId": "GetApplicationResource", - "description": "This example shows how to get an application resource.", - "parameters": { - "applicationResourceName": "helloWorldApp", - "api-version": "6.3-preview" - }, - "responses": { - "200": { - "body": { - "name": "helloWorldApp", - "properties": { - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - } - } +{ + "operationId": "GetApplicationResource", + "description": "This example shows how to get an application resource.", + "parameters": { + "applicationResourceName": "helloWorldApp", + "api-version": "6.3-preview" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldApp", + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplica.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplica.json index 73b69f0bd1be..e60ba88bef4e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplica.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplica.json @@ -1,48 +1,48 @@ -{ - "operationId": "GetReplica", - "description": "This example shows how to get the description of the specified service in an application resource.", - "parameters": { - "api-version": "6.3-preview", - "applicationResourceName": "helloWorldApp", - "serviceResourceName": "helloWorldService", - "replicaName": "0" - }, - "responses": { - "200": { - "body": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - } - } - } - ], - "networkRefs": [], - "replicaName": "0s" - } - } - } +{ + "operationId": "GetReplica", + "description": "This example shows how to get the description of the specified service in an application resource.", + "parameters": { + "api-version": "6.3-preview", + "applicationResourceName": "helloWorldApp", + "serviceResourceName": "helloWorldService", + "replicaName": "0" + }, + "responses": { + "200": { + "body": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [], + "replicaName": "0s" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplicas.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplicas.json index aa27b0198260..f59de11738d8 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplicas.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetReplicas.json @@ -1,86 +1,86 @@ -{ - "operationId": "GetReplica", - "description": "This example shows how to get the information about all replicas of a given service of an application..", - "parameters": { - "api-version": "6.3-preview", - "applicationResourceName": "helloWorldApp", - "serviceResourceName": "helloWorldService" - }, - "responses": { - "200": { - "body": { - "ContinuationToken": "", - "Items": [ - { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - } - } - } - ], - "networkRefs": [], - "replicaName": "1" - }, - { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - } - } - } - ], - "networkRefs": [], - "replicaName": "0" - } - ] - } - } - } +{ + "operationId": "GetReplica", + "description": "This example shows how to get the information about all replicas of a given service of an application..", + "parameters": { + "api-version": "6.3-preview", + "applicationResourceName": "helloWorldApp", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "ContinuationToken": "", + "Items": [ + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [], + "replicaName": "1" + }, + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [], + "replicaName": "0" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetService.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetService.json index 008b92352eab..52b7d883b774 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetService.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetService.json @@ -1,42 +1,42 @@ -{ - "operationId": "GetService", - "description": "This example shows how to get a specific replica of a given service in an application resource.", - "parameters": { - "api-version": "6.3-preview", - "applicationResourceName": "helloWorldApp", - "serviceResourceName": "helloWorldService" - }, - "responses": { - "200": { - "body": { - "name": "helloWorldService", - "properties": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "networkRefs": [], - "description": "SeaBreeze Hello World Service.", - "replicaCount": 2, - "healthState": "Ok", - "status": "Active" - } - } - } - } +{ + "operationId": "GetService", + "description": "This example shows how to get a specific replica of a given service in an application resource.", + "parameters": { + "api-version": "6.3-preview", + "applicationResourceName": "helloWorldApp", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 2, + "healthState": "Ok", + "status": "Active" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetServices.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetServices.json index 891abaecf7d5..d8967583f096 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetServices.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetServices.json @@ -1,46 +1,46 @@ -{ - "operationId": "GetServices", - "description": "This example shows how to list all services of a given application resource.", - "parameters": { - "api-version": "6.3-preview", - "applicationResourceName": "helloWorldApp" - }, - "responses": { - "200": { - "body": { - "ContinuationToken": "", - "Items": [ - { - "name": "helloWorldService", - "properties": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "networkRefs": [], - "description": "SeaBreeze Hello World Service.", - "replicaCount": 1, - "healthState": "Ok", - "status": "Unknown" - } - } - ] - } - } - } +{ + "operationId": "GetServices", + "description": "This example shows how to list all services of a given application resource.", + "parameters": { + "api-version": "6.3-preview", + "applicationResourceName": "helloWorldApp" + }, + "responses": { + "200": { + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "helloWorldService", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Unknown" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetVolumeResource.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetVolumeResource.json index 5063822e6924..c2aa93b5bff7 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetVolumeResource.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/Resource/GetVolumeResource.json @@ -1,23 +1,23 @@ -{ - "operationId": "GetVolumeResource", - "description": "This example shows how to get an volume resource.", - "parameters": { - "volumeResourceName": "meshDemoVolume", - "api-version": "6.3-preview" - }, - "responses": { - "200": { - "body": { - "name": "meshDemoVolume", - "properties": { - "description": "SeaBreeze HelloWorld Application!", - "provider": "SFAzureFile", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - } - } - } - } - } +{ + "operationId": "GetVolumeResource", + "description": "This example shows how to get an volume resource.", + "parameters": { + "volumeResourceName": "meshDemoVolume", + "api-version": "6.3-preview" + }, + "responses": { + "200": { + "body": { + "name": "meshDemoVolume", + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/RestorePartition.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/RestorePartition.json index 65f0d973e19b..2517de87856f 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/RestorePartition.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/RestorePartition.json @@ -1,21 +1,21 @@ -{ - "operationId": "RestorePartition", - "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", - "RestorePartitionDescription": { - "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", - "BackupStorage": { - "StorageKind": "AzureBlobStore", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - }, - "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip" - } - }, - "responses": { - "202": { - } - } +{ + "operationId": "RestorePartition", + "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "RestorePartitionDescription": { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip" + } + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeApplicationBackup.json index 3a001609f1d3..c2c11c4f9d0a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumeApplicationBackup", - "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumeApplicationBackup", + "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumePartitionBackup.json index a2adf7def604..f902b478d32e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumePartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumePartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumePartitionBackup", - "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumePartitionBackup", + "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeServiceBackup.json index 2a1dde5a6c07..69ea5b861c11 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/ResumeServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "ResumeServiceBackup", - "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "ResumeServiceBackup", + "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/StartClusterConfigurationUpgrade-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/StartClusterConfigurationUpgrade-1.json index 6bd0e2ab12ed..bbb6034fc8e4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/StartClusterConfigurationUpgrade-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/StartClusterConfigurationUpgrade-1.json @@ -1,42 +1,42 @@ -{ - "operationId": "StartClusterConfigurationUpgrade", - "description": "This example shows how to start upgrading the configuration of a Service Fabric standalone cluster.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps/CalculatorApp", - "ClusterConfigurationUpgradeDescription": { - "ClusterConfig": "", - "ApplicationHealthPolicies": { - "ApplicationHealthPolicyMap": [ - { - "Key": "fabric:/samples/CalculatorApp", - "Value": { - "ConsiderWarningAsError": true, - "MaxPercentUnhealthyDeployedApplications": 10, - "DefaultServiceTypeHealthPolicy": { - "MaxPercentUnhealthyPartitionsPerService": 0, - "MaxPercentUnhealthyReplicasPerPartition": 0, - "MaxPercentUnhealthyServices": 0 - }, - "ServiceTypeHealthPolicyMap": [ - { - "Key": "Svc1Type", - "Value": { - "MaxPercentUnhealthyPartitionsPerService": 0, - "MaxPercentUnhealthyReplicasPerPartition": 0, - "MaxPercentUnhealthyServices": 10 - } - } - ] - } - } - ] - } - - } - }, - "responses": { - "202": { - } - } -} +{ + "operationId": "StartClusterConfigurationUpgrade", + "description": "This example shows how to start upgrading the configuration of a Service Fabric standalone cluster.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "ClusterConfigurationUpgradeDescription": { + "ClusterConfig": "", + "ApplicationHealthPolicies": { + "ApplicationHealthPolicyMap": [ + { + "Key": "fabric:/samples/CalculatorApp", + "Value": { + "ConsiderWarningAsError": true, + "MaxPercentUnhealthyDeployedApplications": 10, + "DefaultServiceTypeHealthPolicy": { + "MaxPercentUnhealthyPartitionsPerService": 0, + "MaxPercentUnhealthyReplicasPerPartition": 0, + "MaxPercentUnhealthyServices": 0 + }, + "ServiceTypeHealthPolicyMap": [ + { + "Key": "Svc1Type", + "Value": { + "MaxPercentUnhealthyPartitionsPerService": 0, + "MaxPercentUnhealthyReplicasPerPartition": 0, + "MaxPercentUnhealthyServices": 10 + } + } + ] + } + } + ] + } + + } + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SubmitPropertyBatch-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SubmitPropertyBatch-1.json index 3b8279165b6a..af100a680c95 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SubmitPropertyBatch-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SubmitPropertyBatch-1.json @@ -1,67 +1,67 @@ -{ - "operationId": "SubmitPropertyBatch", - "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.", - "parameters": { - "api-version": "6.0", - "nameId": "samples/apps", - "PropertyBatchDescriptionList": { - "Operations": [ - { - "Kind": "CheckExists", - "PropertyName": "PersistentQueueAppData", - "Exits": true - }, - { - "Kind": "CheckSequence", - "PropertyName": "PersistentQueueAppData", - "SequenceNumber": "12" - }, - { - "Kind": "Put", - "PropertyName": "PersistentQueueAppData", - "Value": { - "Kind": "Binary", - "Data": [1, 2, 3, 4, 5] - }, - "CustomTypeId": "InitializationData" - }, - { - "Kind": "Get", - "PropertyName": "PersistentQueueAppData", - "IncludeValue": false - } - ] - } - }, - "responses": { - "200": { - "headers": { - }, - "body": { - "Kind": "Successful", - "Properties": { - "3": { - "Name": "PersistentQueueAppData", - "Metadata": { - "TypeId": "Binary", - "CustomTypeId": "InitializationData", - "Parent": "fabric:/samples/apps", - "SizeInBytes": 5, - "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z", - "SequenceNumber": "13" - } - } - } - } - }, - "409": { - "headers": { - }, - "body": { - "Kind": "Failed", - "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED", - "OperationIndex": 1 - } - } - } -} +{ + "operationId": "SubmitPropertyBatch", + "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyBatchDescriptionList": { + "Operations": [ + { + "Kind": "CheckExists", + "PropertyName": "PersistentQueueAppData", + "Exits": true + }, + { + "Kind": "CheckSequence", + "PropertyName": "PersistentQueueAppData", + "SequenceNumber": "12" + }, + { + "Kind": "Put", + "PropertyName": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [1, 2, 3, 4, 5] + }, + "CustomTypeId": "InitializationData" + }, + { + "Kind": "Get", + "PropertyName": "PersistentQueueAppData", + "IncludeValue": false + } + ] + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Successful", + "Properties": { + "3": { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationData", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z", + "SequenceNumber": "13" + } + } + } + } + }, + "409": { + "headers": { + }, + "body": { + "Kind": "Failed", + "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED", + "OperationIndex": 1 + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendApplicationBackup.json index 1a50c91da730..862c3b5387d8 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendApplicationBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendApplicationBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendApplicationBackup", - "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "applicationId": "CalcApp" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendApplicationBackup", + "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendPartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendPartitionBackup.json index 62a9731b6936..74e24683205a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendPartitionBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendPartitionBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendPartitionBackup", - "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendPartitionBackup", + "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendServiceBackup.json index a61d4669f67d..f39d03482610 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendServiceBackup.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/SuspendServiceBackup.json @@ -1,12 +1,12 @@ -{ - "operationId": "SuspendServiceBackup", - "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", - "parameters": { - "api-version": "6.2-preview", - "serviceId": "CalcApp/CalcService" - }, - "responses": { - "202": { - } - } +{ + "operationId": "SuspendServiceBackup", + "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", + "parameters": { + "api-version": "6.2-preview", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateBackupPolicy.json index 7517350c76a6..5421b431a968 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateBackupPolicy.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateBackupPolicy.json @@ -1,31 +1,31 @@ -{ - "operationId": "UpdateBackupPolicy", - "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", - "parameters": { - "api-version": "6.2-preview", - "backupPolicyName": "DailyAzureBackupPolicy", - "BackupPolicyDescription": { - "Name": "DailyAzureBackupPolicy", - "AutoRestoreOnDataLoss": false, - "MaxIncrementalBackups": 3, - "Schedule": { - "ScheduleKind": "TimeBased", - "ScheduleFrequencyType": "Daily", - "RunTimes": [ - "0001-01-01T09:00:00Z", - "0001-01-01T17:00:00Z" - ] - }, - "Storage": { - "StorageKind": "AzureBlobStore", - "FriendlyName": "Azure_storagesample", - "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", - "ContainerName": "BackupContainer" - } - } - }, - "responses": { - "200": { - } - } +{ + "operationId": "UpdateBackupPolicy", + "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.2-preview", + "backupPolicyName": "DailyAzureBackupPolicy", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "200": { + } + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-1.json index 094f2116cbaa..3a748e8e3e20 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-1.json @@ -1,34 +1,34 @@ -{ - "operationId": "UpdateService", - "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.", - "parameters": { - "serviceId": "test~test1", - "api-version": "6.0", - "ServiceUpdateDescription": { - "ServiceKind": "Stateless", - "Flags": "1568", - "PlacementConstraints": "Color==Red", - "DefaultMoveCost": "High", - "ScalingPolicies": [ - { - "ScalingTrigger": { - "Kind": "AveragePartitionLoad", - "MetricName": "servicefabric:\/_CpuCores", - "LowerLoadThreshold": 0.500000, - "UpperLoadThreshold": 0.800000, - "ScaleIntervalInSeconds": 900 - }, - "ScalingMechanism": { - "Kind": "PartitionInstanceCount", - "MinInstanceCount": 4, - "MaxInstanceCount": 6, - "ScaleIncrement": 2 - } - } - ] - } - }, - "responses": { - "200": {} - } +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.", + "parameters": { + "serviceId": "test~test1", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateless", + "Flags": "1568", + "PlacementConstraints": "Color==Red", + "DefaultMoveCost": "High", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.500000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 900 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 4, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-2.json index c5dca7b1cc6e..4329ddddf400 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-2.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/UpdateService-2.json @@ -1,17 +1,17 @@ -{ - "operationId": "UpdateService", - "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.", - "parameters": { - "serviceId": "test~test2", - "api-version": "6.0", - "ServiceUpdateDescription": { - "ServiceKind": "Stateful", - "Flags": "40", - "PlacementConstraints": "Color==Green", - "StandByReplicaKeepDurationSeconds": "1000" - } - }, - "responses": { - "200": {} - } +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.", + "parameters": { + "serviceId": "test~test2", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateful", + "Flags": "40", + "PlacementConstraints": "Color==Green", + "StandByReplicaKeepDurationSeconds": "1000" + } + }, + "responses": { + "200": {} + } } \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json index 1bc3931d0c02..48a561698ec4 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json @@ -1,25887 +1,25887 @@ -{ - "swagger": "2.0", - "info": { - "title": "Service Fabric Client APIs", - "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.", - "version": "6.3.0.9" - }, - "host": "localhost:19080", - "schemes": [ - "http", - "https" - ], - "produces": [ - "application/json" - ], - "paths": { - "/$/GetClusterManifest": { - "get": { - "operationId": "GetClusterManifest", - "summary": "Get the Service Fabric cluster manifest.", - "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster manifest information.", - "schema": { - "$ref": "#/definitions/ClusterManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterHealth": { - "get": { - "operationId": "GetClusterHealth", - "summary": "Gets the health of a Service Fabric cluster.", - "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health information.", - "schema": { - "$ref": "#/definitions/ClusterHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetClusterHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric cluster using the specified policy.", - "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health information.", - "schema": { - "$ref": "#/definitions/ClusterHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterHealthChunk": { - "get": { - "operationId": "GetClusterHealthChunk", - "summary": "Gets the health of a Service Fabric cluster using health chunks.", - "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", - "schema": { - "$ref": "#/definitions/ClusterHealthChunk" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters", - "summary": "Gets the health of a Service Fabric cluster using health chunks.", - "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", - "schema": { - "$ref": "#/definitions/ClusterHealthChunk" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/ReportClusterHealth": { - "post": { - "operationId": "ReportClusterHealth", - "summary": "Sends a health report on the Service Fabric cluster.", - "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetProvisionedCodeVersions": { - "get": { - "operationId": "GetProvisionedFabricCodeVersionInfoList", - "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.", - "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/CodeVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested provisioned code versions information.", - "schema": { - "$ref": "#/definitions/FabricCodeVersionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetProvisionedConfigVersions": { - "get": { - "operationId": "GetProvisionedFabricConfigVersionInfoList", - "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.", - "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ConfigVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested provisioned config versions information.", - "schema": { - "$ref": "#/definitions/FabricConfigVersionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetUpgradeProgress": { - "get": { - "operationId": "GetClusterUpgradeProgress", - "summary": "Gets the progress of the current cluster upgrade.", - "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.", - "schema": { - "$ref": "#/definitions/ClusterUpgradeProgressObject" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterConfiguration": { - "get": { - "operationId": "GetClusterConfiguration", - "summary": "Get the Service Fabric standalone cluster configuration.", - "description": "The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster configuration information.", - "schema": { - "$ref": "#/definitions/ClusterConfiguration" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetClusterConfigurationUpgradeStatus": { - "get": { - "operationId": "GetClusterConfigurationUpgradeStatus", - "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.", - "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.", - "schema": { - "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetUpgradeOrchestrationServiceState": { - "get": { - "operationId": "GetUpgradeOrchestrationServiceState", - "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.", - "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceState" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/SetUpgradeOrchestrationServiceState": { - "post": { - "operationId": "SetUpgradeOrchestrationServiceState", - "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.", - "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", - "tags": [ - "Cluster" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Provision": { - "post": { - "summary": "Provision the code or configuration packages of a Service Fabric cluster.", - "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.", - "operationId": "ProvisionCluster", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the code or configuration packages have been provisioned." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Unprovision": { - "post": { - "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.", - "description": "It is supported to unprovision code and configuration separately.", - "operationId": "UnprovisionCluster", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the code or configuration packages have been unprovisioned." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RollbackUpgrade": { - "post": { - "summary": "Rollback the upgrade of a Service Fabric cluster.", - "description": "Rollback the code or configuration upgrade of a Service Fabric cluster.", - "operationId": "RollbackClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "202": { - "description": "A successful response means that the rollback of a cluster upgrade has been initiated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/MoveToNextUpgradeDomain": { - "post": { - "summary": "Make the cluster upgrade move on to the next upgrade domain.", - "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.", - "operationId": "ResumeClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/Upgrade": { - "post": { - "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.", - "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.", - "operationId": "StartClusterUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "202": { - "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/StartClusterConfigurationUpgrade": { - "post": { - "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.", - "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.", - "operationId": "StartClusterConfigurationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "Start upgrading the configuration of a Service Fabric standalone cluster": { - "$ref": "./examples/StartClusterConfigurationUpgrade-1.json" - } - }, - "responses": { - "202": { - "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateUpgrade": { - "post": { - "operationId": "UpdateClusterUpgrade", - "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.", - "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetAadMetadata": { - "get": { - "operationId": "GetAadMetadata", - "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.", - "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "schemes": [ - "https" - ], - "tags": [ - "Cluster" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.", - "schema": { - "$ref": "#/definitions/AadMetadataObject" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes": { - "get": { - "summary": "Gets the list of nodes in the Service Fabric cluster.", - "description": "The response includes the name, status, ID, health, uptime, and other details about the nodes.", - "operationId": "GetNodeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Node" - ], - "x-ms-examples": { - "Get information about all nodes": { - "$ref": "./examples/GetNodeInfoList.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetNodeInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetNodeInfoList-2.json" - } - }, - "responses": { - "200": { - "description": "List of nodes in the cluster.", - "schema": { - "$ref": "#/definitions/PagedNodeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}": { - "get": { - "summary": "Gets the information about a specific node in the Service Fabric cluster.", - "description": "The response includes the name, status, ID, health, uptime, and other details about the node.", - "operationId": "GetNodeInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Node" - ], - "x-ms-examples": { - "Get a specific node by node name": { - "$ref": "./examples/GetNodeInfo-1.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return information about the node with the specified nodeName.", - "schema": { - "$ref": "#/definitions/NodeInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified nodeName is not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetHealth": { - "get": { - "operationId": "GetNodeHealth", - "summary": "Gets the health of a Service Fabric node.", - "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/NodeHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetNodeHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric node, by using the specified health policy.", - "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/NodeHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/ReportHealth": { - "post": { - "operationId": "ReportNodeHealth", - "summary": "Sends a health report on the Service Fabric node.", - "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetLoadInformation": { - "get": { - "operationId": "GetNodeLoadInfo", - "summary": "Gets the load information of a Service Fabric node.", - "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node load information.", - "schema": { - "$ref": "#/definitions/NodeLoadInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Deactivate": { - "post": { - "operationId": "DisableNode", - "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.", - "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Activate": { - "post": { - "operationId": "EnableNode", - "summary": "Activate a Service Fabric cluster node that is currently deactivated.", - "description": "Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/RemoveNodeState": { - "post": { - "operationId": "RemoveNodeState", - "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.", - "description": "This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Restart": { - "post": { - "operationId": "RestartNode", - "summary": "Restarts a Service Fabric cluster node.", - "description": "Restarts a Service Fabric cluster node that is already started.", - "tags": [ - "Node" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes": { - "get": { - "summary": "Gets the list of application types in the Service Fabric cluster.", - "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", - "operationId": "GetApplicationTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationTypeInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationTypeInfoList-2.json" - }, - "Exclude application parameters from the result": { - "$ref": "./examples/GetApplicationTypeInfoList-3.json" - } - }, - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "List of application types in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}": { - "get": { - "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.", - "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", - "operationId": "GetApplicationTypeInfoListByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "List of application types in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/$/Provision": { - "post": { - "operationId": "ProvisionApplicationType", - "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.", - "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.", - "tags": [ - "ApplicationType" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful provision will return 200 status code." - }, - "202": { - "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { - "post": { - "operationId": "UnprovisionApplicationType", - "summary": "Removes or unregisters a Service Fabric application type from the cluster.", - "description": "This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.", - "tags": [ - "ApplicationType" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful provision will return 200 status code." - }, - "202": { - "description": "A 202 status code indicates the operation was accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { - "get": { - "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.", - "operationId": "GetServiceTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "x-ms-examples": { - "Get information about all nodes.": { - "$ref": "./examples/GetServiceTypeInfoList-1.json" - } - }, - "responses": { - "200": { - "description": "List of service types that are supported by a provisioned application type.", - "schema": { - "$ref": "#/definitions/ServiceTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { - "get": { - "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", - "operationId": "GetServiceTypeInfoByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "x-ms-examples": { - "Get information about all nodes.": { - "$ref": "./examples/GetServiceTypeInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "A specific service type which supported by a provisioned application type.", - "schema": { - "$ref": "#/definitions/ServiceTypeInfo" - } - }, - "204": { - "description": "A 204 response is returned if the specified service type is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { - "get": { - "summary": "Gets the manifest describing a service type.", - "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.", - "operationId": "GetServiceManifest", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "Information about the service type.", - "schema": { - "$ref": "#/definitions/ServiceTypeManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": { - "get": { - "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.", - "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.", - "operationId": "GetDeployedServiceTypeInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "List of information about service types of an application deployed on a node.", - "schema": { - "$ref": "#/definitions/DeployedServiceTypeInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": { - "get": { - "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.", - "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.", - "operationId": "GetDeployedServiceTypeInfoByName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ServiceType" - ], - "responses": { - "200": { - "description": "Information about service types of an application deployed on a node.", - "schema": { - "$ref": "#/definitions/DeployedServiceTypeInfoList" - } - }, - "204": { - "description": "An empty response is returned if the specified service type of the application is not deployed on the node." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/$/Create": { - "post": { - "summary": "Creates a Service Fabric application.", - "description": "Creates a Service Fabric application using the specified description.", - "operationId": "CreateApplication", - "x-ms-examples": { - "Create application.": { - "$ref": "./examples/CreateApplication-1.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "201": { - "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric application.", - "description": "An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.", - "operationId": "DeleteApplication", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetLoadInformation": { - "get": { - "summary": "Gets load information about a Service Fabric application.", - "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.", - "operationId": "GetApplicationLoadInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "Information about the application load.", - "schema": { - "$ref": "#/definitions/ApplicationLoadInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications": { - "get": { - "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.", - "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.", - "operationId": "GetApplicationInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationInfoList-2.json" - } - }, - "responses": { - "200": { - "description": "List of applications created in the cluster.", - "schema": { - "$ref": "#/definitions/PagedApplicationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}": { - "get": { - "summary": "Gets information about a Service Fabric application.", - "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.", - "operationId": "GetApplicationInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "x-ms-examples": { - "Get a specific application by application id": { - "$ref": "./examples/GetApplicationInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "Information about the application.", - "schema": { - "$ref": "#/definitions/ApplicationInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the service fabric application.", - "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.", - "operationId": "GetApplicationHealth", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested application health information.", - "schema": { - "$ref": "#/definitions/ApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetApplicationHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric application using the specified policy.", - "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested node health information.", - "schema": { - "$ref": "#/definitions/ApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/ReportHealth": { - "post": { - "operationId": "ReportApplicationHealth", - "summary": "Sends a health report on the Service Fabric application.", - "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/Upgrade": { - "post": { - "summary": "Starts upgrading an application in the Service Fabric cluster.", - "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.", - "operationId": "StartApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetUpgradeProgress": { - "get": { - "summary": "Gets details for the latest upgrade performed on this application.", - "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.", - "operationId": "GetApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "The application upgrade details.", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/UpdateUpgrade": { - "post": { - "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.", - "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.", - "operationId": "UpdateApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": { - "post": { - "summary": "Resumes upgrading an application in the Service Fabric cluster.", - "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.", - "operationId": "ResumeApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/RollbackUpgrade": { - "post": { - "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.", - "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.", - "operationId": "RollbackApplicationUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications": { - "get": { - "operationId": "GetDeployedApplicationInfoList", - "summary": "Gets the list of applications deployed on a Service Fabric node.", - "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetDeployedApplicationInfoList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetDeployedApplicationInfoList-2.json" - }, - "Include health state in the result": { - "$ref": "./examples/GetDeployedApplicationInfoList-3.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed application information.", - "schema": { - "$ref": "#/definitions/PagedDeployedApplicationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}": { - "get": { - "operationId": "GetDeployedApplicationInfo", - "summary": "Gets the information about an application deployed on a Service Fabric node.", - "description": "This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get a specific deployed application by application ID and include the health state in the result": { - "$ref": "./examples/GetDeployedApplicationInfoByName-1.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the information about the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified application is not deployed on the node." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": { - "get": { - "operationId": "GetDeployedApplicationHealth", - "summary": "Gets the information about health of an application deployed on a Service Fabric node.", - "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetDeployedApplicationHealthUsingPolicy", - "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.", - "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Application" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed application.", - "schema": { - "$ref": "#/definitions/DeployedApplicationHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": { - "post": { - "operationId": "ReportDeployedApplicationHealth", - "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.", - "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.", - "tags": [ - "Application" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { - "get": { - "summary": "Gets the manifest describing an application type.", - "description": "The response contains the application manifest XML as a string.", - "operationId": "GetApplicationManifest", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ApplicationType" - ], - "responses": { - "200": { - "description": "Information about the node.", - "schema": { - "$ref": "#/definitions/ApplicationTypeManifest" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices": { - "get": { - "summary": "Gets the information about all services belonging to the application specified by the application ID.", - "description": "Returns the information about all services belonging to the application specified by the application ID.", - "operationId": "GetServiceInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "List of services in the cluster for the specified application.", - "schema": { - "$ref": "#/definitions/PagedServiceInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/{serviceId}": { - "get": { - "summary": "Gets the information about the specific service belonging to the Service Fabric application.", - "description": "Returns the information about the specified service belonging to the specified Service Fabric application.", - "operationId": "GetServiceInfo", - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "Information about the specified service.", - "schema": { - "$ref": "#/definitions/ServiceInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified service is not part of the specified application." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetApplicationName": { - "get": { - "summary": "Gets the name of the Service Fabric application for a service.", - "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.", - "operationId": "GetApplicationNameInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "Information about the name of the application for the specified service.", - "schema": { - "$ref": "#/definitions/ApplicationNameInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/$/Create": { - "post": { - "operationId": "CreateService", - "summary": "Creates the specified Service Fabric service.", - "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.", - "x-ms-examples": { - "Basic stateless service": { - "$ref": "./examples/CreateService-1.json" - }, - "Basic stateful service": { - "$ref": "./examples/CreateService-2.json" - }, - "Stateless service with dns name and auto scaling": { - "$ref": "./examples/CreateService-3.json" - }, - "Stateful service with named partitions and auto scaling": { - "$ref": "./examples/CreateService-4.json" - } - }, - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": { - "post": { - "summary": "Creates a Service Fabric service from the service template.", - "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.", - "operationId": "CreateServiceFromTemplate", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric service.", - "description": "A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.", - "operationId": "DeleteService", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/Update": { - "post": { - "operationId": "UpdateService", - "summary": "Updates a Service Fabric service using the specified update description.", - "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.", - "x-ms-examples": { - "Stateless service": { - "$ref": "./examples/UpdateService-1.json" - }, - "Stateful service": { - "$ref": "./examples/UpdateService-2.json" - } - }, - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetDescription": { - "get": { - "summary": "Gets the description of an existing Service Fabric service.", - "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.", - "operationId": "GetServiceDescription", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the specified Service Fabric service.", - "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", - "operationId": "GetServiceHealth", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the specified service.", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.", - "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", - "operationId": "GetServiceHealthUsingPolicy", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the specified service.", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ReportHealth": { - "post": { - "operationId": "ReportServiceHealth", - "summary": "Sends a health report on the Service Fabric service.", - "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ResolvePartition": { - "get": { - "operationId": "ResolveService", - "summary": "Resolve a Service Fabric partition.", - "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.", - "tags": [ - "Service" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam" - }, - { - "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam" - }, - { - "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/ResolvedServicePartition" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetPartitions": { - "get": { - "summary": "Gets the list of partitions of a Service Fabric service.", - "description": "The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", - "operationId": "GetPartitionInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "List of partitions of a Service Fabric service.", - "schema": { - "$ref": "#/definitions/PagedServicePartitionInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}": { - "get": { - "summary": "Gets the information about a Service Fabric partition.", - "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", - "operationId": "GetPartitionInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the specified partition.", - "schema": { - "$ref": "#/definitions/ServicePartitionInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified partitionId is not found in the cluster." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetServiceName": { - "get": { - "summary": "Gets the name of the Service Fabric service for a partition.", - "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.", - "operationId": "GetServiceNameInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the name of the service for the specified partition.", - "schema": { - "$ref": "#/definitions/ServiceNameInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetHealth": { - "get": { - "summary": "Gets the health of the specified Service Fabric partition.", - "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.", - "operationId": "GetPartitionHealth", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information about the specified partition.", - "schema": { - "$ref": "#/definitions/PartitionHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.", - "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.", - "operationId": "GetPartitionHealthUsingPolicy", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information about the specified partition.", - "schema": { - "$ref": "#/definitions/PartitionHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ReportHealth": { - "post": { - "operationId": "ReportPartitionHealth", - "summary": "Sends a health report on the Service Fabric partition.", - "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetLoadInformation": { - "get": { - "summary": "Gets the load information of the specified Service Fabric partition.", - "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.", - "operationId": "GetPartitionLoadInformation", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Partition" - ], - "responses": { - "200": { - "description": "Information about the specified partition's last reported load metrics.", - "schema": { - "$ref": "#/definitions/PartitionLoadInformation" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ResetLoad": { - "post": { - "operationId": "ResetPartitionLoad", - "summary": "Resets the current load of a Service Fabric partition.", - "description": "Resets the current load of a Service Fabric partition to the default load for the service.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Recover": { - "post": { - "operationId": "RecoverPartition", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.", - "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/$/{serviceId}/$/GetPartitions/$/Recover": { - "post": { - "operationId": "RecoverServicePartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RecoverSystemPartitions": { - "post": { - "operationId": "RecoverSystemPartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.", - "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/RecoverAllPartitions": { - "post": { - "operationId": "RecoverAllPartitions", - "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.", - "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", - "tags": [ - "Partition" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation request will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/CreateRepairTask": { - "post": { - "operationId": "CreateRepairTask", - "summary": "Creates a new repair task.", - "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/CancelRepairTask": { - "post": { - "operationId": "CancelRepairTask", - "summary": "Requests the cancellation of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/DeleteRepairTask": { - "post": { - "operationId": "DeleteRepairTask", - "summary": "Deletes a completed repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/GetRepairTaskList": { - "get": { - "operationId": "GetRepairTaskList", - "summary": "Gets a list of repair tasks matching the given filters.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.", - "schema": { - "$ref": "#/definitions/RepairTaskList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/ForceApproveRepairTask": { - "post": { - "operationId": "ForceApproveRepairTask", - "summary": "Forces the approval of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateRepairTaskHealthPolicy": { - "post": { - "operationId": "UpdateRepairTaskHealthPolicy", - "summary": "Updates the health policy of the given repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/UpdateRepairExecutionState": { - "post": { - "operationId": "UpdateRepairExecutionState", - "summary": "Updates the execution state of a repair task.", - "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/RepairTaskRequiredBodyParam" - } - ], - "tags": [ - "RepairManagement" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", - "schema": { - "$ref": "#/definitions/RepairTaskUpdateInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas": { - "get": { - "summary": "Gets the information about replicas of a Service Fabric service partition.", - "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", - "operationId": "GetReplicaInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "Information about the replicas of the specified partition.", - "schema": { - "$ref": "#/definitions/PagedReplicaInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { - "get": { - "summary": "Gets the information about a replica of a Service Fabric partition.", - "description": "The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", - "operationId": "GetReplicaInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "Information about the specified replicas of the specified partition of a Service Fabric service.", - "schema": { - "$ref": "#/definitions/ReplicaInfo" - } - }, - "204": { - "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { - "get": { - "operationId": "GetReplicaHealth", - "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.", - "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested replica health.", - "schema": { - "$ref": "#/definitions/ReplicaHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetReplicaHealthUsingPolicy", - "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.", - "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Replica" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested replica health information.", - "schema": { - "$ref": "#/definitions/ReplicaHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { - "post": { - "operationId": "ReportReplicaHealth", - "summary": "Sends a health report on the Service Fabric replica.", - "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": { - "get": { - "operationId": "GetDeployedServiceReplicaInfoList", - "summary": "Gets the list of replicas deployed on a Service Fabric node.", - "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaInfoList" - } - }, - "204": { - "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": { - "get": { - "operationId": "GetDeployedServiceReplicaDetailInfo", - "summary": "Gets the details of replica deployed on a Service Fabric node.", - "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": { - "get": { - "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId", - "summary": "Gets the details of replica deployed on a Service Fabric node.", - "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service replica information.", - "schema": { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": { - "post": { - "operationId": "RestartReplica", - "summary": "Restarts a service replica of a persisted service running on a node.", - "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": { - "post": { - "operationId": "RemoveReplica", - "summary": "Removes a service replica running on a node.", - "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.", - "tags": [ - "Replica" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": { - "get": { - "operationId": "GetDeployedServicePackageInfoList", - "summary": "Gets the list of service packages deployed on a Service Fabric node.", - "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service packages information.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": { - "get": { - "operationId": "GetDeployedServicePackageInfoListByName", - "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.", - "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed service packages information.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageInfoList" - } - }, - "204": { - "description": "An empty response is returned if the specified service package from the application is not deployed on the node." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { - "get": { - "operationId": "GetDeployedServicePackageHealth", - "summary": "Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.", - "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "GetDeployedServicePackageHealthUsingPolicy", - "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.", - "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Service Package" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", - "schema": { - "$ref": "#/definitions/DeployedServicePackageHealth" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": { - "post": { - "operationId": "ReportDeployedServicePackageHealth", - "summary": "Sends a health report on the Service Fabric deployed service package.", - "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServicePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/HealthInformationRequiredBodyParam" - }, - { - "$ref": "#/parameters/ImmediateOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/DeployServicePackage": { - "post": { - "operationId": "DeployServicePackageToNode", - "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.", - "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.", - "tags": [ - "Service Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": { - "get": { - "operationId": "GetDeployedCodePackageInfoList", - "summary": "Gets the list of code packages deployed on a Service Fabric node.", - "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the list of deployed code packages information.", - "schema": { - "$ref": "#/definitions/DeployedCodePackageInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": { - "post": { - "operationId": "RestartDeployedCodePackage", - "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.", - "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": { - "get": { - "operationId": "GetContainerLogsDeployedOnNode", - "summary": "Gets the container logs for container deployed on a Service Fabric node.", - "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.", - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TailOptionalQueryParam" - }, - { - "$ref": "#/parameters/PreviousOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get container logs for given code package": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json" - }, - "Get last 10 lines of container logs": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json" - }, - "Get container logs of previous dead container for given code package": { - "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json" - } - }, - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.", - "schema": { - "$ref": "#/definitions/ContainerLogs" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": { - "post": { - "operationId": "InvokeContainerApi", - "summary": "Invoke container API on a container deployed on a Service Fabric node.", - "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.", - "x-ms-examples": { - "Get container logs": { - "$ref": "./examples/InvokeContainerApi.json" - }, - "Update container": { - "$ref": "./examples/InvokeContainerApi_Post.json" - } - }, - "tags": [ - "Code Package" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContainerApiRequiredBodyParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.", - "schema": { - "$ref": "#/definitions/ContainerApiResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/$/Create": { - "put": { - "summary": "Creates a Service Fabric compose deployment.", - "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.", - "operationId": "CreateComposeDeployment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}": { - "get": { - "summary": "Gets information about a Service Fabric compose deployment.", - "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.", - "operationId": "GetComposeDeploymentStatus", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "Information about the compose deployment.", - "schema": { - "$ref": "#/definitions/ComposeDeploymentStatusInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments": { - "get": { - "summary": "Gets the list of compose deployments created in the Service Fabric cluster.", - "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.", - "operationId": "GetComposeDeploymentStatusList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "List of status of compose deployments in the cluster.", - "schema": { - "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": { - "get": { - "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.", - "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.", - "operationId": "GetComposeDeploymentUpgradeProgress", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "200": { - "description": "Details about the compose deployment upgrade.", - "schema": { - "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/Delete": { - "post": { - "summary": "Deletes an existing Service Fabric compose deployment from cluster.", - "description": "Deletes an existing Service Fabric compose deployment.", - "operationId": "RemoveComposeDeployment", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful operation will return 202 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ComposeDeployments/{deploymentName}/$/Upgrade": { - "post": { - "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.", - "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.", - "operationId": "StartComposeDeploymentUpgrade", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/DeploymentNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Compose Deployment" - ], - "responses": { - "202": { - "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos": { - "get": { - "operationId": "GetChaos", - "summary": "Get the status of Chaos.", - "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the status of Chaos.", - "schema": { - "$ref": "#/definitions/Chaos" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/$/Start": { - "post": { - "operationId": "StartChaos", - "summary": "Starts Chaos in the cluster.", - "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nRefer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.", - "tags": [ - "Chaos" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ChaosParametersRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/$/Stop": { - "post": { - "operationId": "StopChaos", - "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.", - "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.", - "tags": [ - "Chaos" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/Events": { - "get": { - "operationId": "GetChaosEvents", - "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.", - "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.", - "x-ms-examples": { - "Get Chaos events given a time range": { - "$ref": "./examples/GetChaosEvents.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "Next segment of Chaos events.", - "schema": { - "$ref": "#/definitions/ChaosEventsSegment" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Tools/Chaos/Schedule": { - "get": { - "operationId": "GetChaosSchedule", - "summary": "Get the Chaos Schedule defining when and how to run Chaos.", - "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.", - "schema": { - "$ref": "#/definitions/ChaosScheduleDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "post": { - "operationId": "PostChaosSchedule", - "summary": "Set the schedule used by Chaos.", - "description": "Chaos will automatically schedule runs based on the Chaos Schedule.\nThe Chaos Schedule will be updated if the provided version matches the version on the server.\nWhen updating the Chaos Schedule, the version on the server is incremented by 1.\nThe version on the server will wrap back to 0 after reaching a large number.\nIf Chaos is running when this call is made, the call will fail.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ChaosScheduleRequiredBodyParam" - } - ], - "tags": [ - "Chaos" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}": { - "put": { - "summary": "Uploads contents of the file to the image store.", - "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.", - "operationId": "UploadFile", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "summary": "Gets the image store content information.", - "description": "Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.", - "operationId": "GetImageStoreContent", - "x-ms-examples": { - "Get information about image store content under a given relative path": { - "$ref": "./examples/GetImageStoreContent.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store content information.", - "schema": { - "$ref": "#/definitions/ImageStoreContent" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes existing image store content.", - "description": "Deletes existing image store content being found within the given image store relative path. This can be used to delete uploaded application packages once they are provisioned.", - "operationId": "DeleteImageStoreContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore": { - "get": { - "summary": "Gets the content information at the root of the image store.", - "description": "Returns the information about the image store content at the root of the image store.", - "operationId": "GetImageStoreRootContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store content information.", - "schema": { - "$ref": "#/definitions/ImageStoreContent" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/Copy": { - "post": { - "summary": "Copies image store content internally", - "description": "Copies the image store content from the source image store relative path to the destination image store relative path.", - "operationId": "CopyImageStoreContent", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/DeleteUploadSession": { - "delete": { - "summary": "Cancels an image store upload session.", - "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.", - "operationId": "DeleteImageStoreUploadSession", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/CommitUploadSession": { - "post": { - "summary": "Commit an image store upload session.", - "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ", - "operationId": "CommitImageStoreUploadSession", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/$/GetUploadSession": { - "get": { - "summary": "Get the image store upload session by ID.", - "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ", - "operationId": "GetImageStoreUploadSessionById", - "x-ms-examples": { - "Get information about image store upload session by a given ID": { - "$ref": "./examples/GetUploadSessionById.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store upload session information.", - "schema": { - "$ref": "#/definitions/UploadSession" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}/$/GetUploadSession": { - "get": { - "summary": "Get the image store upload session by relative path.", - "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ", - "operationId": "GetImageStoreUploadSessionByPath", - "x-ms-examples": { - "Get information about image store upload session by a given relative path": { - "$ref": "./examples/GetUploadSessionByPath.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the requested image store upload session information.", - "schema": { - "$ref": "#/definitions/UploadSession" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/ImageStore/{contentPath}/$/UploadChunk": { - "put": { - "summary": "Uploads a file chunk to the image store relative path.", - "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.", - "operationId": "UploadFileChunk", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" - }, - { - "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "ImageStore" - ], - "responses": { - "200": { - "description": "A successful operation will return the HTTP 200 OK status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/InvokeInfrastructureCommand": { - "post": { - "operationId": "InvokeInfrastructureCommand", - "summary": "Invokes an administrative command on the given Infrastructure Service instance.", - "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Infrastructure" - ], - "responses": { - "200": { - "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", - "schema": { - "$ref": "#/definitions/InfrastructureServiceResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/$/InvokeInfrastructureQuery": { - "get": { - "operationId": "InvokeInfrastructureQuery", - "summary": "Invokes a read-only query on the given infrastructure service instance.", - "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" - }, - { - "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Infrastructure" - ], - "responses": { - "200": { - "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", - "schema": { - "$ref": "#/definitions/InfrastructureServiceResponse" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": { - "post": { - "operationId": "StartDataLoss", - "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.", - "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode.\n\n- PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\n- FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/DataLossModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": { - "get": { - "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.", - "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.", - "operationId": "GetDataLossProgress", - "x-ms-examples": { - "Gets information about a partition data loss operation. In this case the operation has a State of Completed": { - "$ref": "./examples/GetDataLossProgress.json" - }, - "Get information about a partition data loss operation. In this case the operation is a State of Running": { - "$ref": "./examples/GetDataLossProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of the partition data loss operation.", - "schema": { - "$ref": "#/definitions/PartitionDataLossProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": { - "post": { - "operationId": "StartQuorumLoss", - "summary": "Induces quorum loss for a given stateful service partition.", - "description": "This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/QuorumLossModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": { - "get": { - "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.", - "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.", - "operationId": "GetQuorumLossProgress", - "x-ms-examples": { - "Gets information about a completed quorum loss operation": { - "$ref": "./examples/GetQuorumLossProgress.json" - }, - "Gets information about a running quorum operation operation": { - "$ref": "./examples/GetQuorumLossProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a partition quorum loss operation.", - "schema": { - "$ref": "#/definitions/PartitionQuorumLossProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": { - "post": { - "operationId": "StartPartitionRestart", - "summary": "This API will restart some or all replicas or instances of the specified partition.", - "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": { - "get": { - "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.", - "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.", - "operationId": "GetPartitionRestartProgress", - "x-ms-examples": { - "Get information a completed PartitionRestart operation": { - "$ref": "./examples/GetPartitionRestartProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a partition restart operation.", - "schema": { - "$ref": "#/definitions/PartitionRestartProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Nodes/{nodeName}/$/StartTransition/": { - "post": { - "operationId": "StartNodeTransition", - "summary": "Starts or stops a cluster node.", - "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": { - "get": { - "summary": "Gets the progress of an operation started using StartNodeTransition.", - "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.", - "operationId": "GetNodeTransitionProgress", - "x-ms-examples": { - "Gets information about a completed NodeTransition operation": { - "$ref": "./examples/GetNodeTransitionProgress.json" - }, - "Gets information about a running NodeTransition operation": { - "$ref": "./examples/GetNodeTransitionProgress-Running.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Faults" - ], - "responses": { - "200": { - "description": "Information about the progress of a node transition operation.", - "schema": { - "$ref": "#/definitions/NodeTransitionProgress" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/": { - "get": { - "operationId": "GetFaultOperationList", - "summary": "Gets a list of user-induced fault operations filtered by provided input.", - "description": "Gets the a list of user-induced fault operations filtered by provided input.", - "x-ms-examples": { - "Gets information on fault operations": { - "$ref": "./examples/GetFaultOperationList.json" - } - }, - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TypeFilterRequiredQueryParam" - }, - { - "$ref": "#/parameters/StateFilterRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code.", - "schema": { - "$ref": "#/definitions/OperationStatusList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Faults/$/Cancel": { - "post": { - "operationId": "CancelOperation", - "summary": "Cancels a user-induced fault operation.", - "description": "The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.", - "tags": [ - "Faults" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" - }, - { - "$ref": "#/parameters/ForceRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/$/Create": { - "post": { - "operationId": "CreateBackupPolicy", - "summary": "Creates a backup policy.", - "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.", - "x-ms-examples": { - "Create a time based backup policy with Azure as backup location": { - "$ref": "./examples/CreateBackupPolicy-1.json" - }, - "Create a frequency based backup policy with file share as backup location": { - "$ref": "./examples/CreateBackupPolicy-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "201": { - "description": "A sucessful operation returns 201 status code and creates a new backup policy." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": { - "post": { - "operationId": "DeleteBackupPolicy", - "summary": "Deletes the backup policy.", - "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.", - "x-ms-examples": { - "Delete backup policy": { - "$ref": "./examples/DeleteBackupPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and deletes the backup policy." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies": { - "get": { - "operationId": "GetBackupPolicyList", - "summary": "Gets all the backup policies configured.", - "description": "Get a list of all the backup policies configured.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetBackupPolicyList-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetBackupPolicyList-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and paged list of backup policies.", - "schema": { - "$ref": "#/definitions/PagedBackupPolicyDescriptionList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}": { - "get": { - "operationId": "GetBackupPolicyByName", - "summary": "Gets a particular backup policy by name.", - "description": "Gets a particular backup policy identified by {backupPolicyName}", - "x-ms-examples": { - "Get backup policy by name": { - "$ref": "./examples/GetBackupPolicyByName.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and the backup policy description.", - "schema": { - "$ref": "#/definitions/BackupPolicyDescription" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": { - "get": { - "operationId": "GetAllEntitiesBackedUpByPolicy", - "summary": "Gets the list of backup entities that are associated with this policy.", - "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.", - "schema": { - "$ref": "#/definitions/PagedBackupEntityList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": { - "post": { - "operationId": "UpdateBackupPolicy", - "summary": "Updates the backup policy.", - "description": "Updates the backup policy identified by {backupPolicyName}", - "x-ms-examples": { - "Update backup policy": { - "$ref": "./examples/UpdateBackupPolicy.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A sucessful operation resturns 200 status code and updates the backup policy description." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/EnableBackup": { - "post": { - "operationId": "EnableApplicationBackup", - "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.", - "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable application backup": { - "$ref": "./examples/EnableApplicationBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable application backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/DisableBackup": { - "post": { - "operationId": "DisableApplicationBackup", - "summary": "Disables periodic backup of Service Fabric application.", - "description": "Disables periodic backup of Service Fabric application which was previously enabled.", - "x-ms-examples": { - "Disable application backup": { - "$ref": "./examples/DisableApplicationBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable application backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetApplicationBackupConfigurationInfo", - "summary": "Gets the Service Fabric application backup configuration information.", - "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.", - "schema": { - "$ref": "#/definitions/PagedBackupConfigurationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/GetBackups": { - "get": { - "operationId": "GetApplicationBackupList", - "summary": "Gets the list of backups available for every partition in this application.", - "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetApplicationBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetApplicationBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetApplicationBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetApplicationBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendApplicationBackup", - "summary": "Suspends periodic backup for the specified Service Fabric application.", - "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.", - "x-ms-examples": { - "Suspend application backup": { - "$ref": "./examples/SuspendApplicationBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Applications/{applicationId}/$/ResumeBackup": { - "post": { - "operationId": "ResumeApplicationBackup", - "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.", - "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume application backup": { - "$ref": "./examples/ResumeApplicationBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/EnableBackup": { - "post": { - "operationId": "EnableServiceBackup", - "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.", - "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable service backup": { - "$ref": "./examples/EnableServiceBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable service backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/DisableBackup": { - "post": { - "operationId": "DisableServiceBackup", - "summary": "Disables periodic backup of Service Fabric service which was previously enabled.", - "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.", - "x-ms-examples": { - "Disable service backup": { - "$ref": "./examples/DisableServiceBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable service backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetServiceBackupConfigurationInfo", - "summary": "Gets the Service Fabric service backup configuration information.", - "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.", - "schema": { - "$ref": "#/definitions/PagedBackupConfigurationInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/GetBackups": { - "get": { - "operationId": "GetServiceBackupList", - "summary": "Gets the list of backups available for every partition in this service.", - "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetServiceBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetServiceBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetServiceBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetServiceBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendServiceBackup", - "summary": "Suspends periodic backup for the specified Service Fabric service.", - "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.", - "x-ms-examples": { - "Suspend service backup": { - "$ref": "./examples/SuspendServiceBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Services/{serviceId}/$/ResumeBackup": { - "post": { - "operationId": "ResumeServiceBackup", - "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.", - "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume service backup": { - "$ref": "./examples/ResumeServiceBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/EnableBackup": { - "post": { - "operationId": "EnablePartitionBackup", - "summary": "Enables periodic backup of the stateful persisted partition.", - "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", - "x-ms-examples": { - "Enable partition backup": { - "$ref": "./examples/EnablePartitionBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to enable partition backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/DisableBackup": { - "post": { - "operationId": "DisablePartitionBackup", - "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.", - "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.", - "x-ms-examples": { - "Disable partition backup": { - "$ref": "./examples/DisablePartitionBackup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the request to disable partition backup has been accepted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": { - "get": { - "operationId": "GetPartitionBackupConfigurationInfo", - "summary": "Gets the partition backup configuration information", - "description": "Gets the Service Fabric Backup configuration information for the specified partition.", - "x-ms-examples": { - "Get partition backup configuration information": { - "$ref": "./examples/GetPartitionBackupConfigurationInfo.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.", - "schema": { - "$ref": "#/definitions/PartitionBackupConfigurationInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackups": { - "get": { - "operationId": "GetPartitionBackupList", - "summary": "Gets the list of backups available for the specified partition.", - "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.", - "x-ms-examples": { - "Get application backups within a time range": { - "$ref": "./examples/GetPartitionBackupList-1.json" - }, - "Get latest backup": { - "$ref": "./examples/GetPartitionBackupList-2.json" - }, - "Limit maximum results": { - "$ref": "./examples/GetPartitionBackupList-3.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetPartitionBackupList-4.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/LatestOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/SuspendBackup": { - "post": { - "operationId": "SuspendPartitionBackup", - "summary": "Suspends periodic backup for the specified partition.", - "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.", - "x-ms-examples": { - "Suspend partition backup": { - "$ref": "./examples/SuspendPartitionBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ResumeBackup": { - "post": { - "operationId": "ResumePartitionBackup", - "summary": "Resumes periodic backup of partition which was previously suspended.", - "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.", - "x-ms-examples": { - "Resume partition backup": { - "$ref": "./examples/ResumePartitionBackup.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Backup": { - "post": { - "operationId": "BackupPartition", - "summary": "Triggers backup of the partition's state.", - "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.", - "x-ms-examples": { - "Backup partition": { - "$ref": "./examples/BackupPartition-1.json" - }, - "Backup partition to a specific Azure storage account": { - "$ref": "./examples/BackupPartition-2.json" - }, - "Backup partition to a specific on-premise file share": { - "$ref": "./examples/BackupPartition-3.json" - } - }, - "tags": [ - "BackupRestore" - ], - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam" - }, - { - "$ref": "#/parameters/BackupTimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetBackupProgress": { - "get": { - "operationId": "GetPartitionBackupProgress", - "summary": "Gets details for the latest backup triggered for this partition.", - "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.", - "x-ms-examples": { - "Get backup operation progress": { - "$ref": "./examples/GetPartitionBackupProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and backup progress details.", - "schema": { - "$ref": "#/definitions/BackupProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Restore": { - "post": { - "operationId": "RestorePartition", - "summary": "Triggers restore of the state of the partition using the specified restore partition description.", - "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.", - "x-ms-examples": { - "Trigger partition restore": { - "$ref": "./examples/RestorePartition.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "202": { - "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetRestoreProgress": { - "get": { - "operationId": "GetPartitionRestoreProgress", - "summary": "Gets details for the latest restore operation triggered for this partition.", - "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.", - "x-ms-examples": { - "Get restore operation progress": { - "$ref": "./examples/GetPartitionRestoreProgress.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation returns 200 status code and restore progress details.", - "schema": { - "$ref": "#/definitions/RestoreProgressInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/BackupRestore/$/GetBackups": { - "post": { - "operationId": "GetBackupsFromBackupLocation", - "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.", - "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).", - "x-ms-examples": { - "Limit maximum results": { - "$ref": "./examples/GetBackupsFromBackupLocation-1.json" - }, - "Page using continuation token": { - "$ref": "./examples/GetBackupsFromBackupLocation-2.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/MaxResultsOptionalQueryParam" - }, - { - "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam" - } - ], - "tags": [ - "BackupRestore" - ], - "responses": { - "200": { - "description": "A successful operation will return 200 status code and a paged list of backup information.", - "schema": { - "$ref": "#/definitions/PagedBackupInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/$/Create": { - "post": { - "summary": "Creates a Service Fabric name.", - "description": "Creates the specified Service Fabric name.", - "operationId": "CreateName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Create new name": { - "$ref": "examples/CreateName-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "201": { - "description": "A successful response means that the name has been created." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}": { - "get": { - "summary": "Returns whether the Service Fabric name exists.", - "description": "Returns whether the specified Service Fabric name exists.", - "operationId": "GetNameExistsInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the Service Fabric name exists." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes a Service Fabric name.", - "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.", - "operationId": "DeleteName", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the Service Fabric name has been deleted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetSubNames": { - "get": { - "summary": "Enumerates all the Service Fabric names under a given name.", - "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.", - "operationId": "GetSubNameInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/RecursiveOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get sub names": { - "$ref": "examples/GetSubNameInfoList-1.json" - }, - "Recursively search sub names": { - "$ref": "examples/GetSubNameInfoList-2.json" - }, - "Page using continuation token": { - "$ref": "examples/GetSubNameInfoList-3.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A paged list of Service Fabric names.", - "schema": { - "$ref": "#/definitions/PagedSubNameInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperties": { - "get": { - "summary": "Gets information on all Service Fabric properties under a given name.", - "description": "A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.", - "operationId": "GetPropertyInfoList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/IncludeValuesOptionalQueryParam" - }, - { - "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get property info list": { - "$ref": "examples/GetPropertyInfoList-1.json" - }, - "Get property info list with values": { - "$ref": "examples/GetPropertyInfoList-2.json" - }, - "Page using continuation token": { - "$ref": "examples/GetPropertyInfoList-3.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A paged list of Service Fabric properties.", - "schema": { - "$ref": "#/definitions/PagedPropertyInfoList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperty": { - "put": { - "summary": "Creates or updates a Service Fabric property.", - "description": "Creates or updates the specified Service Fabric property under a given name.", - "operationId": "PutProperty", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Put property": { - "$ref": "examples/PutProperty-1.json" - }, - "Put custom property": { - "$ref": "examples/PutProperty-2.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property has been created or updated." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "summary": "Gets the specified Service Fabric property.", - "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.", - "operationId": "GetPropertyInfo", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Get property info": { - "$ref": "examples/GetPropertyInfo-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "Details on the Service Fabric property.", - "schema": { - "$ref": "#/definitions/PropertyInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "summary": "Deletes the specified Service Fabric property.", - "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.", - "operationId": "DeleteProperty", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyNameRequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property has been deleted." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Names/{nameId}/$/GetProperties/$/SubmitBatch": { - "post": { - "summary": "Submits a property batch.", - "description": "Submits a batch of property operations. Either all or none of the operations will be committed.", - "operationId": "SubmitPropertyBatch", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NameIdRequiredPathParam" - }, - { - "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "x-ms-examples": { - "Property batch operation": { - "$ref": "examples/SubmitPropertyBatch-1.json" - } - }, - "tags": [ - "Property Management" - ], - "responses": { - "200": { - "description": "A successful response means that the property batch succeeded.", - "schema": { - "$ref": "#/definitions/SuccessfulPropertyBatchInfo" - } - }, - "409": { - "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", - "schema": { - "$ref": "#/definitions/FailedPropertyBatchInfo" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Cluster/Events": { - "get": { - "summary": "Gets all Cluster-related events.", - "description": "The response is list of ClusterEvent objects.", - "operationId": "GetClusterEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Cluster-related events": { - "$ref": "./examples/GetClusterEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ClusterEvent.", - "schema": { - "$ref": "#/definitions/ClusterEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Containers/Events": { - "get": { - "summary": "Gets all Containers-related events.", - "description": "The response is list of ContainerInstanceEvent objects.", - "operationId": "GetContainersEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "responses": { - "200": { - "description": "List of events objects with base type ContainerInstanceEvent.", - "schema": { - "$ref": "#/definitions/ContainerInstanceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Nodes/{nodeName}/$/Events": { - "get": { - "summary": "Gets a Node-related events.", - "description": "The response is list of NodeEvent objects.", - "operationId": "GetNodeEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/NodeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Node-related events": { - "$ref": "./examples/GetNodeEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type NodeEvent.", - "schema": { - "$ref": "#/definitions/NodeEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Nodes/Events": { - "get": { - "summary": "Gets all Nodes-related Events.", - "description": "The response is list of NodeEvent objects.", - "operationId": "GetNodesEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Nodes-related events": { - "$ref": "./examples/GetNodesEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type NodeEvent.", - "schema": { - "$ref": "#/definitions/NodeEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Applications/{applicationId}/$/Events": { - "get": { - "summary": "Gets an Application-related events.", - "description": "The response is list of ApplicationEvent objects.", - "operationId": "GetApplicationEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Application-related events": { - "$ref": "./examples/GetApplicationEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ApplicationEvent.", - "schema": { - "$ref": "#/definitions/ApplicationEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Applications/Events": { - "get": { - "summary": "Gets all Applications-related events.", - "description": "The response is list of ApplicationEvent objects.", - "operationId": "GetApplicationsEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Applications-related events": { - "$ref": "./examples/GetApplicationsEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ApplicationEvent.", - "schema": { - "$ref": "#/definitions/ApplicationEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Services/{serviceId}/$/Events": { - "get": { - "summary": "Gets a Service-related events.", - "description": "The response is list of ServiceEvent objects.", - "operationId": "GetServiceEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ServiceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Service-related events": { - "$ref": "./examples/GetServiceEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ServiceEvent.", - "schema": { - "$ref": "#/definitions/ServiceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Services/Events": { - "get": { - "summary": "Gets all Services-related events.", - "description": "The response is list of ServiceEvent objects.", - "operationId": "GetServicesEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Services-related events": { - "$ref": "./examples/GetServicesEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ServiceEvent.", - "schema": { - "$ref": "#/definitions/ServiceEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Events": { - "get": { - "summary": "Gets a Partition-related events.", - "description": "The response is list of PartitionEvent objects.", - "operationId": "GetPartitionEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition-related events": { - "$ref": "./examples/GetPartitionEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type PartitionEvent.", - "schema": { - "$ref": "#/definitions/PartitionEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/Events": { - "get": { - "summary": "Gets all Partitions-related events.", - "description": "The response is list of PartitionEvent objects.", - "operationId": "GetPartitionsEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partitions-related events": { - "$ref": "./examples/GetPartitionsEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type PartitionEvent.", - "schema": { - "$ref": "#/definitions/PartitionEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": { - "get": { - "summary": "Gets a Partition Replica-related events.", - "description": "The response is list of ReplicaEvent objects.", - "operationId": "GetPartitionReplicaEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition Replica-related events": { - "$ref": "./examples/GetReplicaEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ReplicaEvent.", - "schema": { - "$ref": "#/definitions/ReplicaEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": { - "get": { - "summary": "Gets all Replicas-related events for a Partition.", - "description": "The response is list of ReplicaEvent objects.", - "operationId": "GetPartitionReplicasEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/PartitionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - }, - { - "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" - }, - { - "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" - }, - { - "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" - }, - { - "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Partition Replicas-related events": { - "$ref": "./examples/GetReplicasEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type ReplicaEvent.", - "schema": { - "$ref": "#/definitions/ReplicaEventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": { - "get": { - "summary": "Gets all correlated events for a given event.", - "description": "The response is list of FabricEvents.", - "operationId": "GetCorrelatedEventList", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/EventInstanceIdRequiredPathParam" - }, - { - "$ref": "#/parameters/TimeoutOptionalQueryParam" - } - ], - "tags": [ - "EventsStore" - ], - "x-ms-examples": { - "Get Correlated events": { - "$ref": "./examples/GetCorrelatedEventList.json" - } - }, - "responses": { - "200": { - "description": "List of events objects with base type FabricEvent.", - "schema": { - "$ref": "#/definitions/EventList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Resources/Applications/{applicationResourceName}": { - "put": { - "operationId": "CreateApplicationResource", - "x-ms-examples": { - "CreateOrUpdateApplicationResource": { - "$ref": "./examples/Resource/CreateOrUpdateApplicationResource.json" - } - }, - "summary": "Creates or updates an application resource.", - "description": "Creates an application with the specified name and description. If an application with the same name already exists, then its description are updated to the one indicated in this request.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "201": { - "description": "Created" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "operationId": "GetApplicationResource", - "x-ms-examples": { - "GetApplicationResource": { - "$ref": "./examples/Resource/GetApplicationResource.json" - } - }, - "summary": "Gets the application with the given name.", - "description": "Gets the application with the given name. This includes the information about the application's services and other runtime information.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "operationId": "DeleteApplicationResource", - "x-ms-examples": { - "DeleteApplicationResource": { - "$ref": "./examples/Resource/DeleteApplicationResource.json" - } - }, - "summary": "Deletes the specified application.", - "description": "Deletes the application identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content - the specified application was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - }, - "/Resources/Applications/{applicationResourceName}/Services": { - "get": { - "operationId": "GetServices", - "x-ms-examples": { - "GetServices": { - "$ref": "./examples/Resource/GetServices.json" - } - }, - "summary": "Gets all the services in the application resource.", - "description": "The operation returns the service descriptions of all the services in the application resource. ", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PagedServiceResourceDescriptionList" - } - } - } - } - }, - "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}": { - "get": { - "operationId": "GetService", - "x-ms-examples": { - "GetService": { - "$ref": "./examples/Resource/GetService.json" - } - }, - "summary": "Gets the description of the specified service in an application resource.", - "description": "Gets the description of the service resource.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResourceDescription" - } - } - } - } - }, - "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/replicas": { - "get": { - "operationId": "GetReplicas", - "x-ms-examples": { - "GetReplicas": { - "$ref": "./examples/Resource/GetReplicas.json" - } - }, - "summary": "Gets replicas of a given service in an applciation resource.", - "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PagedServiceResourceReplicaDescriptionList" - } - } - } - } - }, - "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}": { - "get": { - "operationId": "GetReplica", - "x-ms-examples": { - "GetReplica": { - "$ref": "./examples/Resource/GetReplica.json" - } - }, - "summary": "Gets a specific replica of a given service in an application resource.", - "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaNameRequiredPathParam" - } - ], - "tags": [ - "ApplicationResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResourceReplicaDescription" - } - } - } - } - }, - "/Resources/Volumes/{volumeResourceName}": { - "put": { - "operationId": "CreateVolumeResource", - "x-ms-examples": { - "CreateOrUpdateVolumeResource": { - "$ref": "./examples/Resource/CreateOrUpdateVolumeResource.json" - } - }, - "summary": "Creates or updates a volume resource.", - "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "VolumeResource" - ], - "responses": { - "201": { - "description": "Created" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "get": { - "operationId": "GetVolumeResource", - "x-ms-examples": { - "GetVolumeResource": { - "$ref": "./examples/Resource/GetVolumeResource.json" - } - }, - "summary": "Gets the volume resource.", - "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - } - ], - "tags": [ - "VolumeResource" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - }, - "delete": { - "operationId": "DeleteVolumeResource", - "x-ms-examples": { - "DeleteVolumeResource": { - "$ref": "./examples/Resource/DeleteVolumeResource.json" - } - }, - "summary": "Deletes the volume resource.", - "description": "Deletes the volume identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - } - ], - "tags": [ - "VolumeResource" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content - the specified volume was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/FabricError" - } - } - } - } - } - }, - "definitions": { - "AadMetadata": { - "type": "object", - "description": "Azure Active Directory metadata used for secured connection to cluster.", - "properties": { - "authority": { - "type": "string", - "description": "The AAD authority url." - }, - "client": { - "type": "string", - "description": "The AAD client application Id." - }, - "cluster": { - "type": "string", - "description": "The AAD cluster application Id." - }, - "login": { - "type": "string", - "description": "The AAD login url." - }, - "redirect": { - "type": "string", - "description": "The client application redirect address." - }, - "tenant": { - "type": "string", - "description": "The AAD tenant Id." - } - } - }, - "AadMetadataObject": { - "type": "object", - "description": "Azure Active Directory metadata object used for secured connection to cluster.", - "properties": { - "type": { - "type": "string", - "description": "The client authentication method." - }, - "metadata": { - "$ref": "#/definitions/AadMetadata", - "description": "Azure Active Directory metadata used for secured connection to cluster." - } - } - }, - "AnalysisEventMetadata": { - "type": "object", - "description": "Metadata about an Analysis Event.", - "properties": { - "Delay": { - "type": "string", - "format": "duration", - "description": "The analysis delay." - }, - "Duration": { - "type": "string", - "format": "duration", - "description": "The duration of analysis." - } - } - }, - "ApplicationDefinitionKind": { - "type": "string", - "description": "The mechanism used to define a Service Fabric application.", - "enum": [ - "Invalid", - "ServiceFabricApplicationDescription", - "Compose" - ], - "x-ms-enum": { - "name": "ApplicationDefinitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535." - }, - { - "value": "ServiceFabricApplicationDescription", - "description": "Indicates the application is defined by a Service Fabric application description. The value is 0." - }, - { - "value": "Compose", - "description": "Indicates the application is defined by compose file(s). The value is 1." - } - ] - } - }, - "ApplicationEvent": { - "description": "Represents the base for all Application Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ApplicationEvent", - "properties": { - "ApplicationId": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - } - }, - "required": [ - "ApplicationId" - ] - } - ], - "x-ms-discriminator-value": "ApplicationEvent" - }, - "ApplicationEventList": { - "description": "A list of ApplicationEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationEvent" - } - }, - "ApplicationHealth": { - "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ApplicationHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthState" - }, - "description": "Service health states as found in the health store." - }, - "DeployedApplicationHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthState" - }, - "description": "Deployed application health states as found in the health store." - } - } - } - ] - }, - "ApplicationHealthEvaluation": { - "x-ms-discriminator-value": "Application", - "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationHealthEvaluation", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "ApplicationHealthPolicies": { - "type": "object", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.", - "properties": { - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster." - } - } - }, - "ApplicationHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.", - "default": 0 - }, - "DefaultServiceTypeHealthPolicy": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The health policy used by default to evaluate the health of a service type." - }, - "ServiceTypeHealthPolicyMap": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMap", - "description": "The map with service type health policy per service type name. The map is empty by default." - } - } - }, - "ApplicationHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthPolicyMapItem" - }, - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - }, - "ApplicationHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ApplicationHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "$ref": "#/definitions/ApplicationName", - "description": "The key of the application health policy map item. This is the name of the application." - }, - "Value": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application." - } - } - }, - "ApplicationHealthState": { - "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ApplicationHealthState", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ] - }, - "ApplicationHealthStateChunk": { - "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ApplicationHealthStateChunk", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "ServiceHealthStateChunks": { - "$ref": "#/definitions/ServiceHealthStateChunkList", - "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description." - }, - "DeployedApplicationHealthStateChunks": { - "$ref": "#/definitions/DeployedApplicationHealthStateChunkList", - "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "ApplicationHealthStateChunkList": { - "type": "object", - "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunkList" - }, - { - "type": "object", - "description": "ApplicationHealthStateChunkList", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthStateChunk" - }, - "description": "The list of application health state chunks that respect the input filters in the chunk query." - } - } - } - ] - }, - "ApplicationHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.", - "properties": { - "ApplicationNameFilter": { - "type": "string", - "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." - }, - "ApplicationTypeNameFilter": { - "type": "string", - "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "ServiceFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthStateFilter" - }, - "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name." - }, - "DeployedApplicationFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthStateFilter" - }, - "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node." - } - } - }, - "ApplicationId": { - "type": "string", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "ApplicationInfo": { - "type": "object", - "description": "Information about a Service Fabric application.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "Status": { - "$ref": "#/definitions/ApplicationStatus", - "description": "The status of the application." - }, - "Parameters": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "ApplicationDefinitionKind": { - "$ref": "#/definitions/ApplicationDefinitionKind", - "description": "The mechanism used to define a Service Fabric application." - } - } - }, - "ApplicationLoadInfo": { - "type": "object", - "description": "Load Information about a Service Fabric application.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "MinimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero." - }, - "MaximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero." - }, - "NodeCount": { - "type": "integer", - "format": "int64", - "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero." - }, - "ApplicationLoadMetricInformation": { - "$ref": "#/definitions/ApplicationMetricDescriptionList", - "description": "List of application capacity metric description." - } - } - }, - "ApplicationName": { - "type": "string", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ApplicationNameInfo": { - "type": "object", - "description": "Information about the application name.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - }, - "ApplicationPackageCleanupPolicy": { - "type": "string", - "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.", - "enum": [ - "Invalid", - "Default", - "Automatic", - "Manual" - ], - "x-ms-enum": { - "name": "ApplicationPackageCleanupPolicy", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero." - }, - { - "value": "Default", - "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1." - }, - { - "value": "Automatic", - "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2." - }, - { - "value": "Manual", - "description": "Indicates that the user has to explicitly clean up the application package. The value is 3." - } - ] - } - }, - "ApplicationParameter": { - "type": "object", - "description": "Describes an application parameter override to be applied when creating or upgrading an application.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The name of the parameter." - }, - "Value": { - "type": "string", - "description": "The value of the parameter." - } - } - }, - "ApplicationParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "ApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "Applications", - "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of applications from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ApplicationStatus": { - "type": "string", - "description": "The status of the application.", - "enum": [ - "Invalid", - "Ready", - "Upgrading", - "Creating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ready", - "description": "Indicates the application status is ready. The value is 1." - }, - { - "value": "Upgrading", - "description": "Indicates the application status is upgrading. The value is 2." - }, - { - "value": "Creating", - "description": "Indicates the application status is creating. The value is 3." - }, - { - "value": "Deleting", - "description": "Indicates the application status is deleting. The value is 4." - }, - { - "value": "Failed", - "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5." - } - ] - } - }, - "ApplicationTypeApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "ApplicationTypeApplications", - "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ApplicationTypeApplicationsHealthEvaluation", - "properties": { - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of applications of the application type found in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health." - } - } - } - ] - }, - "ApplicationTypeDefinitionKind": { - "type": "string", - "description": "The mechanism used to define a Service Fabric application type.", - "enum": [ - "Invalid", - "ServiceFabricApplicationPackage", - "Compose" - ], - "x-ms-enum": { - "name": "ApplicationTypeDefinitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0." - }, - { - "value": "ServiceFabricApplicationPackage", - "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1." - }, - { - "value": "Compose", - "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2." - } - ] - } - }, - "ApplicationTypeHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem" - }, - "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." - }, - "ApplicationTypeHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ApplicationTypeHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key of the application type health policy map item. This is the name of the application type." - }, - "Value": { - "type": "integer", - "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100." - } - } - }, - "ApplicationTypeInfo": { - "type": "object", - "description": "Information about an application type.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "Version": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "DefaultParameterList": { - "$ref": "#/definitions/ApplicationTypeParameterList", - "description": "List of application type parameters that can be overridden when creating or updating the application." - }, - "Status": { - "$ref": "#/definitions/ApplicationTypeStatus", - "description": "The status of the application type." - }, - "StatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the application type." - }, - "ApplicationTypeDefinitionKind": { - "$ref": "#/definitions/ApplicationTypeDefinitionKind", - "description": "The mechanism used to define a Service Fabric application type." - } - } - }, - "PagedApplicationTypeInfoList": { - "type": "object", - "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of application type information.", - "items": { - "$ref": "#/definitions/ApplicationTypeInfo" - } - } - } - }, - "ApplicationTypeManifest": { - "type": "object", - "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.", - "properties": { - "Manifest": { - "type": "string", - "description": "The XML manifest as a string." - } - } - }, - "ApplicationTypeName": { - "type": "string", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application type parameters that can be overridden when creating or updating the application." - }, - "ApplicationTypeStatus": { - "type": "string", - "description": "The status of the application type.", - "enum": [ - "Invalid", - "Provisioning", - "Available", - "Unprovisioning", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationTypeStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Provisioning", - "description": "Indicates that the application type is being provisioned in the cluster. The value is 1." - }, - { - "value": "Available", - "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2." - }, - { - "value": "Unprovisioning", - "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3." - }, - { - "value": "Failed", - "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4." - } - ] - } - }, - "ApplicationUnhealthyEvaluations": { - "description": "List of health evaluations that resulted in the current aggregated health state.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvaluationWrapper" - } - }, - "ApplicationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.", - "properties": { - "Name": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "Parameters": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - } - }, - "required": [ - "Name", - "TargetApplicationTypeVersion", - "UpgradeKind", - "Parameters" - ] - }, - "ApplicationUpgradeProgressInfo": { - "type": "object", - "description": "Describes the parameters for an application upgrade.", - "properties": { - "Name": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "UpgradeDomains": { - "$ref": "#/definitions/UpgradeDomainInfoList", - "description": "List of upgrade domains and their statuses." - }, - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "NextUpgradeDomain": { - "$ref": "#/definitions/NextUpgradeDomain", - "description": "The name of the next upgrade domain to be processed." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeDescription": { - "$ref": "#/definitions/ApplicationUpgradeDescription", - "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription." - }, - "UpgradeDurationInMilliseconds": { - "type": "string", - "description": "The estimated total amount of time spent processing the overall upgrade." - }, - "UpgradeDomainDurationInMilliseconds": { - "type": "string", - "description": "The estimated total amount of time spent processing the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade started." - }, - "FailureTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", - "description": "Information about the upgrade domain progress at the time of upgrade failure." - }, - "UpgradeStatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the pending upgrade." - } - } - }, - "ByteArray": { - "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.", - "type": "array", - "items": { - "type": "integer" - } - }, - "ClusterConfiguration": { - "type": "object", - "description": "Information about the standalone cluster configuration.", - "properties": { - "ClusterConfiguration": { - "type": "string", - "description": "The contents of the cluster configuration file." - } - } - }, - "ClusterEvent": { - "description": "Represents the base for all Cluster Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ClusterEvent" - } - ], - "x-ms-discriminator-value": "ClusterEvent" - }, - "ClusterEventList": { - "description": "A list of ClusterEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ClusterEvent" - } - }, - "ClusterHealth": { - "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ClusterHealth", - "properties": { - "NodeHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthState" - }, - "description": "Cluster node health states as found in the health store." - }, - "ApplicationHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthState" - }, - "description": "Cluster application health states as found in the health store." - } - } - } - ] - }, - "ClusterHealthChunk": { - "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.", - "type": "object", - "properties": { - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies." - }, - "NodeHealthStateChunks": { - "$ref": "#/definitions/NodeHealthStateChunkList", - "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description." - }, - "ApplicationHealthStateChunks": { - "$ref": "#/definitions/ApplicationHealthStateChunkList", - "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description." - } - } - }, - "ClusterHealthChunkQueryDescription": { - "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.", - "properties": { - "NodeFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthStateFilter" - }, - "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName." - }, - "ApplicationFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationHealthStateFilter" - }, - "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "ApplicationHealthPolicies": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "ClusterHealthPolicies": { - "description": "Health policies to evaluate cluster health.", - "properties": { - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - } - } - }, - "ClusterHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.", - "default": 0 - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.", - "default": 0 - }, - "ApplicationTypeHealthPolicyMap": { - "$ref": "#/definitions/ApplicationTypeHealthPolicyMap", - "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." - } - } - }, - "ClusterManifest": { - "type": "object", - "description": "Information about the cluster manifest.", - "properties": { - "Manifest": { - "type": "string", - "description": "The contents of the cluster manifest file." - } - } - }, - "ContainerApiRequestBody": { - "type": "object", - "description": "parameters for making container API call.", - "properties": { - "HttpVerb": { - "type": "string", - "description": "HTTP verb of container REST API, defaults to \"GET\"" - }, - "UriPath": { - "type": "string", - "description": "URI path of container REST API" - }, - "Content-Type": { - "type": "string", - "description": "Content type of container REST API request, defaults to \"application/json\"" - }, - "Body": { - "type": "string", - "description": "HTTP request body of container REST API" - } - }, - "required": [ - "UriPath" - ] - }, - "ContainerApiResponse": { - "type": "object", - "description": "Response body that wraps container API result.", - "properties": { - "ContainerApiResult": { - "$ref": "#/definitions/ContainerApiResult", - "description": "Container API result." - } - }, - "required": [ - "ContainerApiResult" - ] - }, - "ContainerApiResult": { - "type": "object", - "description": "Container API result.", - "properties": { - "Status": { - "type": "integer", - "description": "HTTP status code returned by the target container API" - }, - "Content-Type": { - "type": "string", - "description": "HTTP content type" - }, - "Content-Encoding": { - "type": "string", - "description": "HTTP content encoding" - }, - "Body": { - "type": "string", - "description": "container API result body" - } - }, - "required": [ - "Status" - ] - }, - "ContainerInstanceEvent": { - "description": "Represents the base for all Container Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ContainerInstanceEvent" - } - ], - "x-ms-discriminator-value": "ContainerInstanceEvent" - }, - "ContainerInstanceEventList": { - "description": "A list of ContainerInstanceEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerInstanceEvent" - } - }, - "ContinuationToken": { - "type": "string", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "CurrentUpgradeDomainProgressInfo": { - "type": "object", - "description": "Information about the current in-progress upgrade domain.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "CurrentUpgradeDomainDuration": { - "type": "string", - "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "DeactivationIntentDescription": { - "description": "Describes the intent or reason for deactivating the node.", - "properties": { - "DeactivationIntent": { - "type": "string", - "description": "Describes the intent or reason for deactivating the node. The possible values are following.", - "enum": [ - "Pause", - "Restart", - "RemoveData" - ], - "x-ms-enum": { - "name": "DeactivationIntent", - "modelAsString": true, - "values": [ - { - "value": "Pause", - "description": "Indicates that the node should be paused. The value is 1." - }, - { - "value": "Restart", - "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2." - }, - { - "value": "RemoveData", - "description": "Indicates the intent is for the node to remove data. The value is 3." - } - ] - } - } - } - }, - "DeltaNodesCheckHealthEvaluation": { - "x-ms-discriminator-value": "DeltaNodesCheck", - "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeltaNodesCheckHealthEvaluation", - "properties": { - "BaselineErrorCount": { - "type": "integer", - "format": "int64", - "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." - }, - "BaselineTotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the health store at the beginning of the cluster upgrade." - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedApplicationHealth": { - "description": "Information about the health of an application deployed on a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "DeployedApplicationHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "Name of the application deployed on the node whose health information is described by this object." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where this application is deployed." - }, - "DeployedServicePackageHealthStates": { - "$ref": "#/definitions/DeployedServicePackageHealthStateList", - "description": "Deployed service package health states for the current deployed application as found in the health store." - } - } - } - ] - }, - "DeployedApplicationHealthEvaluation": { - "x-ms-discriminator-value": "DeployedApplication", - "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedApplicationHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where the application is deployed to." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "DeployedApplicationHealthState": { - "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "DeployedApplicationHealthState", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node on which the service package is deployed." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ] - }, - "DeployedApplicationHealthStateChunk": { - "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "DeployedApplicationHealthStateChunk", - "properties": { - "NodeName": { - "type": "string", - "description": "The name of node where the application is deployed." - }, - "DeployedServicePackageHealthStateChunks": { - "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList", - "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "DeployedApplicationHealthStateChunkList": { - "type": "object", - "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationHealthStateChunk" - }, - "description": "The list of deployed application health state chunks that respect the input filters in the chunk query." - } - } - }, - "DeployedApplicationHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.", - "properties": { - "NodeNameFilter": { - "type": "string", - "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "DeployedServicePackageFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthStateFilter" - }, - "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node." - } - } - }, - "DeployedApplicationInfo": { - "type": "object", - "description": "Information about application deployed on the node.", - "properties": { - "Id": { - "$ref": "#/definitions/ApplicationId", - "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "Status": { - "$ref": "#/definitions/DeployedApplicationStatus", - "description": "The status of the application deployed on the node. Following are the possible values." - }, - "WorkDirectory": { - "type": "string", - "description": "The work directory of the application on the node. The work directory can be used to store application data." - }, - "LogDirectory": { - "type": "string", - "description": "The log directory of the application on the node. The log directory can be used to store application logs." - }, - "TempDirectory": { - "type": "string", - "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "DeployedApplicationInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplicationInfo" - }, - "description": "List of deployed application information." - }, - "DeployedApplicationsHealthEvaluation": { - "x-ms-discriminator-value": "DeployedApplications", - "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedApplicationsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of deployed applications of the application in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedApplicationStatus": { - "type": "string", - "description": "The status of the application deployed on the node. Following are the possible values.", - "enum": [ - "Invalid", - "Downloading", - "Activating", - "Active", - "Upgrading", - "Deactivating" - ], - "x-ms-enum": { - "name": "DeployedApplicationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Downloading", - "description": "Indicates that the package is downloading from the ImageStore. The value is 1." - }, - { - "value": "Activating", - "description": "Indicates that the package is activating. The value is 2." - }, - { - "value": "Active", - "description": "Indicates that the package is active. The value is 3." - }, - { - "value": "Upgrading", - "description": "Indicates that the package is upgrading. The value is 4." - }, - { - "value": "Deactivating", - "description": "Indicates that the package is deactivating. The value is 5." - } - ] - } - }, - "DeployedServicePackageHealth": { - "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "DeployedServicePackageHealth", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "Name of the service manifest." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node where this service package is deployed." - } - } - } - ] - }, - "DeployedServicePackageHealthEvaluation": { - "x-ms-discriminator-value": "DeployedServicePackage", - "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "DeployedServicePackageHealthState": { - "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthState", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node on which the service package is deployed." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "Name of the manifest describing the service package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - } - ] - }, - "DeployedServicePackageHealthStateChunk": { - "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "DeployedServicePackageHealthStateChunk", - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - } - ] - }, - "DeployedServicePackageHealthStateChunkList": { - "type": "object", - "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthStateChunk" - }, - "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query." - } - } - }, - "DeployedServicePackageHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.", - "properties": { - "ServiceManifestNameFilter": { - "type": "string", - "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "ServicePackageActivationIdFilter": { - "type": "string", - "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "DeployedServicePackageHealthStateList": { - "description": "List of health states for a service package deployed on a Service Fabric node.", - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageHealthState" - } - }, - "DeployedServicePackagesHealthEvaluation": { - "x-ms-discriminator-value": "DeployedServicePackages", - "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "DeployedServicePackagesHealthEvaluation", - "properties": { - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of deployed service packages of the deployed application in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "DeployedServiceReplicaInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service replica deployed on a node.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package that hosts this replica." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "ReplicaStatus": { - "$ref": "#/definitions/ReplicaStatus", - "description": "The status of a replica of a service." - }, - "Address": { - "type": "string", - "description": "The last address returned by the replica in Open or ChangeRole." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "HostProcessId": { - "type": "string", - "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel." - } - } - }, - "DeployedServiceReplicaInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - "description": "List of deployed service replica information." - }, - "DeployedStatefulServiceReplicaInfo": { - "description": "Information about a stateful service replica deployed on a node.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - { - "type": "object", - "description": "DeployedStatefulServiceReplicaInfo", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - }, - "ReconfigurationInformation": { - "$ref": "#/definitions/ReconfigurationInformation", - "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time." - } - } - } - ] - }, - "DeployedStatelessServiceInstanceInfo": { - "description": "Information about a stateless service instance deployed on a node.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaInfo" - }, - { - "type": "object", - "description": "DeployedStatelessServiceInstanceInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "EntityHealth": { - "type": "object", - "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.", - "properties": { - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy." - }, - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - }, - "description": "The list of health events reported on the entity." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager." - }, - "HealthStatistics": { - "$ref": "#/definitions/HealthStatistics", - "description": "Shows the health statistics for all children types of the queried entity." - } - } - }, - "EntityHealthState": { - "type": "object", - "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.", - "properties": { - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "EntityHealthStateChunk": { - "type": "object", - "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.", - "properties": { - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - } - } - }, - "EntityHealthStateChunkList": { - "type": "object", - "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.", - "properties": { - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description." - } - } - }, - "Epoch": { - "type": "object", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", - "properties": { - "ConfigurationVersion": { - "type": "string", - "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." - }, - "DataLossVersion": { - "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." - } - } - }, - "BackupEpoch": { - "type": "object", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", - "properties": { - "ConfigurationNumber": { - "type": "string", - "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." - }, - "DataLossNumber": { - "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." - } - } - }, - "EventHealthEvaluation": { - "x-ms-discriminator-value": "Event", - "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "EventHealthEvaluation", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity." - }, - "UnhealthyEvent": { - "$ref": "#/definitions/HealthEvent", - "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager." - } - } - } - ] - }, - "EventList": { - "description": "A list of FabricEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/FabricEvent" - } - }, - "FabricCodeVersionInfo": { - "type": "object", - "description": "Information about a Service Fabric code version.", - "properties": { - "CodeVersion": { - "description": "The product version of Service Fabric.", - "type": "string" - } - } - }, - "FabricCodeVersionInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/FabricCodeVersionInfo" - }, - "description": "List of all Service Fabric code versions." - }, - "FabricConfigVersionInfo": { - "type": "object", - "description": "Information about a Service Fabric config version.", - "properties": { - "ConfigVersion": { - "description": "The config version of Service Fabric.", - "type": "string" - } - } - }, - "FabricConfigVersionInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/FabricConfigVersionInfo" - }, - "description": "List of all Service Fabric config versions." - }, - "FabricError": { - "type": "object", - "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.", - "properties": { - "Error": { - "$ref": "#/definitions/FabricErrorError", - "description": "Error object containing error code and error message." - } - }, - "required": [ - "Error" - ] - }, - "FabricErrorError": { - "type": "object", - "description": "Error object containing error code and error message.", - "properties": { - "Code": { - "$ref": "#/definitions/FabricErrorCodes", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" - }, - "Message": { - "type": "string", - "description": "Error message." - } - }, - "required": [ - "Code" - ] - }, - "FabricErrorCodes": { - "type": "string", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", - "enum": [ - "FABRIC_E_INVALID_PARTITION_KEY", - "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", - "FABRIC_E_INVALID_ADDRESS", - "FABRIC_E_APPLICATION_NOT_UPGRADING", - "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR", - "FABRIC_E_FABRIC_NOT_UPGRADING", - "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR", - "FABRIC_E_INVALID_CONFIGURATION", - "FABRIC_E_INVALID_NAME_URI", - "FABRIC_E_PATH_TOO_LONG", - "FABRIC_E_KEY_TOO_LARGE", - "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED", - "FABRIC_E_INVALID_ATOMIC_GROUP", - "FABRIC_E_VALUE_EMPTY", - "FABRIC_E_NODE_NOT_FOUND", - "FABRIC_E_APPLICATION_TYPE_NOT_FOUND", - "FABRIC_E_APPLICATION_NOT_FOUND", - "FABRIC_E_SERVICE_TYPE_NOT_FOUND", - "FABRIC_E_SERVICE_DOES_NOT_EXIST", - "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND", - "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND", - "FABRIC_E_PARTITION_NOT_FOUND", - "FABRIC_E_REPLICA_DOES_NOT_EXIST", - "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST", - "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND", - "FABRIC_E_DIRECTORY_NOT_FOUND", - "FABRIC_E_FABRIC_VERSION_NOT_FOUND", - "FABRIC_E_FILE_NOT_FOUND", - "FABRIC_E_NAME_DOES_NOT_EXIST", - "FABRIC_E_PROPERTY_DOES_NOT_EXIST", - "FABRIC_E_ENUMERATION_COMPLETED", - "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND", - "FABRIC_E_KEY_NOT_FOUND", - "FABRIC_E_HEALTH_ENTITY_NOT_FOUND", - "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION", - "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS", - "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS", - "FABRIC_E_SERVICE_ALREADY_EXISTS", - "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS", - "FABRIC_E_APPLICATION_TYPE_IN_USE", - "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION", - "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS", - "FABRIC_E_FABRIC_VERSION_IN_USE", - "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS", - "FABRIC_E_NAME_ALREADY_EXISTS", - "FABRIC_E_NAME_NOT_EMPTY", - "FABRIC_E_PROPERTY_CHECK_FAILED", - "FABRIC_E_SERVICE_METADATA_MISMATCH", - "FABRIC_E_SERVICE_TYPE_MISMATCH", - "FABRIC_E_HEALTH_STALE_REPORT", - "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED", - "FABRIC_E_NODE_HAS_NOT_STOPPED_YET", - "FABRIC_E_INSTANCE_ID_MISMATCH", - "FABRIC_E_VALUE_TOO_LARGE", - "FABRIC_E_NO_WRITE_QUORUM", - "FABRIC_E_NOT_PRIMARY", - "FABRIC_E_NOT_READY", - "FABRIC_E_RECONFIGURATION_PENDING", - "FABRIC_E_SERVICE_OFFLINE", - "E_ABORT", - "FABRIC_E_COMMUNICATION_ERROR", - "FABRIC_E_OPERATION_NOT_COMPLETE", - "FABRIC_E_TIMEOUT", - "FABRIC_E_NODE_IS_UP", - "E_FAIL", - "FABRIC_E_BACKUP_IS_ENABLED", - "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH", - "FABRIC_E_INVALID_FOR_STATELESS_SERVICES", - "FABRIC_E_BACKUP_NOT_ENABLED", - "FABRIC_E_BACKUP_POLICY_NOT_EXISTING", - "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING", - "FABRIC_E_BACKUP_IN_PROGRESS", - "FABRIC_E_RESTORE_IN_PROGRESS", - "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING", - "FABRIC_E_INVALID_SERVICE_SCALING_POLICY", - "E_INVALIDARG", - "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS", - "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND", - "FABRIC_E_VOLUME_ALREADY_EXISTS", - "FABRIC_E_VOLUME_NOT_FOUND", - "SerializationError" - ], - "x-ms-enum": { - "name": "FabricErrorCodes", - "modelAsString": true, - "values": [ - { - "value": "FABRIC_E_INVALID_PARTITION_KEY" - }, - { - "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_INVALID_ADDRESS" - }, - { - "value": "FABRIC_E_APPLICATION_NOT_UPGRADING" - }, - { - "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_FABRIC_NOT_UPGRADING" - }, - { - "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" - }, - { - "value": "FABRIC_E_INVALID_CONFIGURATION" - }, - { - "value": "FABRIC_E_INVALID_NAME_URI" - }, - { - "value": "FABRIC_E_PATH_TOO_LONG" - }, - { - "value": "FABRIC_E_KEY_TOO_LARGE" - }, - { - "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" - }, - { - "value": "FABRIC_E_INVALID_ATOMIC_GROUP" - }, - { - "value": "FABRIC_E_VALUE_EMPTY" - }, - { - "value": "FABRIC_E_NODE_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_NOT_FOUND" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND" - }, - { - "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" - }, - { - "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" - }, - { - "value": "FABRIC_E_PARTITION_NOT_FOUND" - }, - { - "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" - }, - { - "value": "FABRIC_E_DIRECTORY_NOT_FOUND" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND" - }, - { - "value": "FABRIC_E_FILE_NOT_FOUND" - }, - { - "value": "FABRIC_E_NAME_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST" - }, - { - "value": "FABRIC_E_ENUMERATION_COMPLETED" - }, - { - "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" - }, - { - "value": "FABRIC_E_KEY_NOT_FOUND" - }, - { - "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" - }, - { - "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_SERVICE_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_APPLICATION_TYPE_IN_USE" - }, - { - "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_FABRIC_VERSION_IN_USE" - }, - { - "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_NAME_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_NAME_NOT_EMPTY" - }, - { - "value": "FABRIC_E_PROPERTY_CHECK_FAILED" - }, - { - "value": "FABRIC_E_SERVICE_METADATA_MISMATCH" - }, - { - "value": "FABRIC_E_SERVICE_TYPE_MISMATCH" - }, - { - "value": "FABRIC_E_HEALTH_STALE_REPORT" - }, - { - "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" - }, - { - "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" - }, - { - "value": "FABRIC_E_INSTANCE_ID_MISMATCH" - }, - { - "value": "FABRIC_E_VALUE_TOO_LARGE" - }, - { - "value": "FABRIC_E_NO_WRITE_QUORUM" - }, - { - "value": "FABRIC_E_NOT_PRIMARY" - }, - { - "value": "FABRIC_E_NOT_READY" - }, - { - "value": "FABRIC_E_RECONFIGURATION_PENDING" - }, - { - "value": "FABRIC_E_SERVICE_OFFLINE" - }, - { - "value": "E_ABORT" - }, - { - "value": "FABRIC_E_COMMUNICATION_ERROR" - }, - { - "value": "FABRIC_E_OPERATION_NOT_COMPLETE" - }, - { - "value": "FABRIC_E_TIMEOUT" - }, - { - "value": "FABRIC_E_NODE_IS_UP" - }, - { - "value": "E_FAIL" - }, - { - "value": "FABRIC_E_BACKUP_IS_ENABLED" - }, - { - "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" - }, - { - "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" - }, - { - "value": "FABRIC_E_BACKUP_NOT_ENABLED" - }, - { - "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" - }, - { - "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" - }, - { - "value": "FABRIC_E_BACKUP_IN_PROGRESS" - }, - { - "value": "FABRIC_E_RESTORE_IN_PROGRESS" - }, - { - "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" - }, - { - "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" - }, - { - "value": "E_INVALIDARG" - }, - { - "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND" - }, - { - "value": "FABRIC_E_VOLUME_ALREADY_EXISTS" - }, - { - "value": "FABRIC_E_VOLUME_NOT_FOUND" - }, - { - "value": "SerializationError" - } - ] - } - }, - "FabricEvent": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the base for all Fabric Events.", - "properties": { - "Kind": { - "$ref": "#/definitions/FabricEventKind", - "description": "The kind of FabricEvent." - }, - "EventInstanceId": { - "type": "string", - "format": "uuid", - "description": "The identifier for the FabricEvent instance." - }, - "TimeStamp": { - "type": "string", - "format": "date-time", - "description": "The time event was logged." - }, - "HasCorrelatedEvents": { - "type": "boolean", - "description": "Shows there is existing related events available." - } - }, - "required": [ - "Kind", - "EventInstanceId", - "TimeStamp" - ] - }, - "FabricEventKind": { - "type": "string", - "description": "The kind of FabricEvent.", - "enum": [ - "ClusterEvent", - "ContainerInstanceEvent", - "NodeEvent", - "ApplicationEvent", - "ServiceEvent", - "PartitionEvent", - "ReplicaEvent", - "PartitionAnalysisEvent", - "ApplicationCreated", - "ApplicationDeleted", - "ApplicationHealthReportCreated", - "ApplicationHealthReportExpired", - "ApplicationUpgradeComplete", - "ApplicationUpgradeDomainComplete", - "ApplicationUpgradeRollbackComplete", - "ApplicationUpgradeRollbackStart", - "ApplicationUpgradeStart", - "DeployedApplicationHealthReportCreated", - "DeployedApplicationHealthReportExpired", - "ProcessDeactivated", - "ContainerDeactivated", - "NodeAborted", - "NodeAborting", - "NodeAdded", - "NodeClose", - "NodeClosing", - "NodeDeactivateComplete", - "NodeDeactivateStart", - "NodeDown", - "NodeHealthReportCreated", - "NodeHealthReportExpired", - "NodeOpenedSuccess", - "NodeOpenFailed", - "NodeOpening", - "NodeRemoved", - "NodeUp", - "PartitionHealthReportCreated", - "PartitionHealthReportExpired", - "PartitionReconfigurationCompleted", - "PartitionPrimaryMoveAnalysis", - "ServiceCreated", - "ServiceDeleted", - "ServiceHealthReportCreated", - "ServiceHealthReportExpired", - "DeployedServiceHealthReportCreated", - "DeployedServiceHealthReportExpired", - "StatefulReplicaHealthReportCreated", - "StatefulReplicaHealthReportExpired", - "StatelessReplicaHealthReportCreated", - "StatelessReplicaHealthReportExpired", - "ClusterHealthReportCreated", - "ClusterHealthReportExpired", - "ClusterUpgradeComplete", - "ClusterUpgradeDomainComplete", - "ClusterUpgradeRollbackComplete", - "ClusterUpgradeRollbackStart", - "ClusterUpgradeStart", - "ChaosStopped", - "ChaosStarted", - "ChaosRestartNodeFaultCompleted", - "ChaosRestartCodePackageFaultScheduled", - "ChaosRestartCodePackageFaultCompleted", - "ChaosRemoveReplicaFaultScheduled", - "ChaosRemoveReplicaFaultCompleted", - "ChaosMoveSecondaryFaultScheduled", - "ChaosMovePrimaryFaultScheduled", - "ChaosRestartReplicaFaultScheduled", - "ChaosRestartNodeFaultScheduled" - ], - "x-ms-enum": { - "name": "FabricEventKind", - "modelAsString": true, - "values": [ - { - "value": "ClusterEvent" - }, - { - "value": "ContainerInstanceEvent" - }, - { - "value": "NodeEvent" - }, - { - "value": "ApplicationEvent" - }, - { - "value": "ServiceEvent" - }, - { - "value": "PartitionEvent" - }, - { - "value": "ReplicaEvent" - }, - { - "value": "PartitionAnalysisEvent" - }, - { - "value": "ApplicationCreated" - }, - { - "value": "ApplicationDeleted" - }, - { - "value": "ApplicationHealthReportCreated" - }, - { - "value": "ApplicationHealthReportExpired" - }, - { - "value": "ApplicationUpgradeComplete" - }, - { - "value": "ApplicationUpgradeDomainComplete" - }, - { - "value": "ApplicationUpgradeRollbackComplete" - }, - { - "value": "ApplicationUpgradeRollbackStart" - }, - { - "value": "ApplicationUpgradeStart" - }, - { - "value": "DeployedApplicationHealthReportCreated" - }, - { - "value": "DeployedApplicationHealthReportExpired" - }, - { - "value": "ProcessDeactivated" - }, - { - "value": "ContainerDeactivated" - }, - { - "value": "NodeAborted" - }, - { - "value": "NodeAborting" - }, - { - "value": "NodeAdded" - }, - { - "value": "NodeClose" - }, - { - "value": "NodeClosing" - }, - { - "value": "NodeDeactivateComplete" - }, - { - "value": "NodeDeactivateStart" - }, - { - "value": "NodeDown" - }, - { - "value": "NodeHealthReportCreated" - }, - { - "value": "NodeHealthReportExpired" - }, - { - "value": "NodeOpenedSuccess" - }, - { - "value": "NodeOpenFailed" - }, - { - "value": "NodeOpening" - }, - { - "value": "NodeRemoved" - }, - { - "value": "NodeUp" - }, - { - "value": "PartitionHealthReportCreated" - }, - { - "value": "PartitionHealthReportExpired" - }, - { - "value": "PartitionReconfigurationCompleted" - }, - { - "value": "PartitionPrimaryMoveAnalysis" - }, - { - "value": "ServiceCreated" - }, - { - "value": "ServiceDeleted" - }, - { - "value": "ServiceHealthReportCreated" - }, - { - "value": "ServiceHealthReportExpired" - }, - { - "value": "DeployedServiceHealthReportCreated" - }, - { - "value": "DeployedServiceHealthReportExpired" - }, - { - "value": "StatefulReplicaHealthReportCreated" - }, - { - "value": "StatefulReplicaHealthReportExpired" - }, - { - "value": "StatelessReplicaHealthReportCreated" - }, - { - "value": "StatelessReplicaHealthReportExpired" - }, - { - "value": "ClusterHealthReportCreated" - }, - { - "value": "ClusterHealthReportExpired" - }, - { - "value": "ClusterUpgradeComplete" - }, - { - "value": "ClusterUpgradeDomainComplete" - }, - { - "value": "ClusterUpgradeRollbackComplete" - }, - { - "value": "ClusterUpgradeRollbackStart" - }, - { - "value": "ClusterUpgradeStart" - }, - { - "value": "ChaosStopped" - }, - { - "value": "ChaosStarted" - }, - { - "value": "ChaosRestartNodeFaultCompleted" - }, - { - "value": "ChaosRestartCodePackageFaultScheduled" - }, - { - "value": "ChaosRestartCodePackageFaultCompleted" - }, - { - "value": "ChaosRemoveReplicaFaultScheduled" - }, - { - "value": "ChaosRemoveReplicaFaultCompleted" - }, - { - "value": "ChaosMoveSecondaryFaultScheduled" - }, - { - "value": "ChaosMovePrimaryFaultScheduled" - }, - { - "value": "ChaosRestartReplicaFaultScheduled" - }, - { - "value": "ChaosRestartNodeFaultScheduled" - } - ] - } - }, - "ClusterConfigurationUpgradeStatusInfo": { - "type": "object", - "description": "Information about a standalone cluster configuration upgrade status.", - "properties": { - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "ProgressStatus": { - "type": "integer", - "description": "The cluster manifest version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster configuration version." - }, - "Details": { - "type": "string", - "description": "The cluster upgrade status details." - } - } - }, - "FailureAction": { - "type": "string", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", - "enum": [ - "Invalid", - "Rollback", - "Manual" - ], - "x-ms-enum": { - "name": "FailureAction", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rollback", - "description": "The upgrade will start rolling back automatically. The value is 1" - }, - { - "value": "Manual", - "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2" - } - ] - } - }, - "FailureReason": { - "type": "string", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed.", - "enum": [ - "None", - "Interrupted", - "HealthCheck", - "UpgradeDomainTimeout", - "OverallUpgradeTimeout" - ], - "x-ms-enum": { - "name": "FailureReason", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Interrupted", - "description": "There was an external request to roll back the upgrade. The value is 1" - }, - { - "value": "HealthCheck", - "description": "The upgrade failed due to health policy violations. The value is 2" - }, - { - "value": "UpgradeDomainTimeout", - "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3" - }, - { - "value": "OverallUpgradeTimeout", - "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4" - } - ] - } - }, - "FailureUpgradeDomainProgressInfo": { - "type": "object", - "description": "Information about the upgrade domain progress at the time of upgrade failure.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "ForceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", - "default": false - }, - "HealthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H10M0S" - }, - "HealthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "HealthCheckWaitDuration": { - "type": "string", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "0" - }, - "HealthEvaluation": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.", - "properties": { - "Kind": { - "$ref": "#/definitions/HealthEvaluationKind", - "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values." - }, - "AggregatedHealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "Description": { - "type": "string", - "description": "Description of the health evaluation, which represents a summary of the evaluation process." - } - }, - "required": [ - "Kind" - ] - }, - "HealthEvaluationKind": { - "type": "string", - "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.", - "enum": [ - "Invalid", - "Event", - "Replicas", - "Partitions", - "DeployedServicePackages", - "DeployedApplications", - "Services", - "Nodes", - "Applications", - "SystemApplication", - "UpgradeDomainDeployedApplications", - "UpgradeDomainNodes", - "Replica", - "Partition", - "DeployedServicePackage", - "DeployedApplication", - "Service", - "Node", - "Application", - "DeltaNodesCheck", - "UpgradeDomainDeltaNodesCheck", - "ApplicationTypeApplications" - ], - "x-ms-enum": { - "name": "HealthEvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the health evaluation is invalid. The value is zero." - }, - { - "value": "Event", - "description": "Indicates that the health evaluation is for a health event. The value is 1." - }, - { - "value": "Replicas", - "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2." - }, - { - "value": "Partitions", - "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3." - }, - { - "value": "DeployedServicePackages", - "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4." - }, - { - "value": "DeployedApplications", - "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5." - }, - { - "value": "Services", - "description": "Indicates that the health evaluation is for services of an application. The value is 6." - }, - { - "value": "Nodes", - "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7." - }, - { - "value": "Applications", - "description": "Indicates that the health evaluation is for the cluster applications. The value is 8." - }, - { - "value": "SystemApplication", - "description": "Indicates that the health evaluation is for the system application. The value is 9." - }, - { - "value": "UpgradeDomainDeployedApplications", - "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10." - }, - { - "value": "UpgradeDomainNodes", - "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11." - }, - { - "value": "Replica", - "description": "Indicates that the health evaluation is for a replica. The value is 13." - }, - { - "value": "Partition", - "description": "Indicates that the health evaluation is for a partition. The value is 14." - }, - { - "value": "DeployedServicePackage", - "description": "Indicates that the health evaluation is for a deployed service package. The value is 16." - }, - { - "value": "DeployedApplication", - "description": "Indicates that the health evaluation is for a deployed application. The value is 17." - }, - { - "value": "Service", - "description": "Indicates that the health evaluation is for a service. The value is 15." - }, - { - "value": "Node", - "description": "Indicates that the health evaluation is for a node. The value is 12." - }, - { - "value": "Application", - "description": "Indicates that the health evaluation is for an application. The value is 18." - }, - { - "value": "DeltaNodesCheck", - "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19." - }, - { - "value": "UpgradeDomainDeltaNodesCheck", - "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20." - }, - { - "value": "ApplicationTypeApplications", - "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21." - } - ] - } - }, - "HealthEvaluationWrapper": { - "type": "object", - "description": "Wrapper object for health evaluation.", - "properties": { - "HealthEvaluation": { - "$ref": "#/definitions/HealthEvaluation", - "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity." - } - } - }, - "HealthEvent": { - "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.", - "allOf": [ - { - "$ref": "#/definitions/HealthInformation" - }, - { - "type": "object", - "description": "HealthEvent", - "properties": { - "IsExpired": { - "type": "boolean", - "description": "Returns true if the health event is expired, otherwise false." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The date and time when the health report was sent by the source." - }, - "LastModifiedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The date and time when the health report was last modified by the health store." - }, - "LastOkTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time." - }, - "LastWarningTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time." - }, - "LastErrorTransitionAt": { - "type": "string", - "format": "date-time", - "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time." - } - } - } - ] - }, - "HealthInformation": { - "type": "object", - "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.", - "required": [ - "SourceId", - "Property", - "HealthState" - ], - "properties": { - "SourceId": { - "type": "string", - "description": "The source name that identifies the client/watchdog/system component that generated the health information." - }, - "Property": { - "type": "string", - "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "TimeToLiveInMilliSeconds": { - "type": "string", - "format": "duration", - "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value." - }, - "Description": { - "type": "string", - "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string." - }, - "SequenceNumber": { - "type": "string", - "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, is the reporter has issues (eg. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state." - } - } - }, - "HealthState": { - "type": "string", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", - "enum": [ - "Invalid", - "Ok", - "Warning", - "Error", - "Unknown" - ], - "x-ms-enum": { - "name": "HealthState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ok", - "description": "Indicates the health state is okay. The value is 1." - }, - { - "value": "Warning", - "description": "Indicates the health state is at a warning level. The value is 2." - }, - { - "value": "Error", - "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." - }, - { - "value": "Unknown", - "description": "Indicates an unknown health status. The value is 65535." - } - ] - } - }, - "Int64RangePartitionInformation": { - "description": "Describes the partition information for the integer range that is based on partition schemes.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Int64Range", - "properties": { - "LowKey": { - "type": "string", - "description": "Specifies the minimum key value handled by this partition." - }, - "HighKey": { - "type": "string", - "description": "Specifies the maximum key value handled by this partition." - } - } - }, - "MonitoringPolicyDescription": { - "type": "object", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode.", - "properties": { - "FailureAction": { - "$ref": "#/definitions/FailureAction", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." - }, - "HealthCheckWaitDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckWaitDuration", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckStableDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckStableDuration", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "$ref": "#/definitions/HealthCheckRetryTimeout", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeTimeout", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeDomainTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainTimeout", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - } - } - }, - "NamedPartitionInformation": { - "description": "Describes the partition information for the name as a string that is based on partition schemes.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Named", - "properties": { - "Name": { - "type": "string", - "description": "Name of the partition." - } - } - }, - "NextUpgradeDomain": { - "type": "string", - "description": "The name of the next upgrade domain to be processed." - }, - "NodeDeactivationInfo": { - "type": "object", - "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.", - "properties": { - "NodeDeactivationIntent": { - "$ref": "#/definitions/NodeDeactivationIntent", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it." - }, - "NodeDeactivationStatus": { - "$ref": "#/definitions/NodeDeactivationStatus", - "description": "The status of node deactivation operation. Following are the possible values." - }, - "NodeDeactivationTask": { - "$ref": "#/definitions/NodeDeactivationTaskList", - "description": "List of tasks representing the deactivation operation on the node." - }, - "PendingSafetyChecks": { - "$ref": "#/definitions/SafetyCheckInfoList", - "description": "List of pending safety checks" - } - } - }, - "NodeDeactivationIntent": { - "type": "string", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it.", - "enum": [ - "Invalid", - "Pause", - "Restart", - "RemoveData", - "RemoveNode" - ], - "x-ms-enum": { - "name": "NodeDeactivationIntent", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." - }, - { - "value": "Pause", - "description": "Indicates that the node should be paused. The value is 1." - }, - { - "value": "Restart", - "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2." - }, - { - "value": "RemoveData", - "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3." - }, - { - "value": "RemoveNode", - "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4." - } - ] - } - }, - "NodeDeactivationStatus": { - "type": "string", - "description": "The status of node deactivation operation. Following are the possible values.", - "enum": [ - "None", - "SafetyCheckInProgress", - "SafetyCheckComplete", - "Completed" - ], - "x-ms-enum": { - "name": "NodeDeactivationStatus", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No status is associated with the task. The value is zero." - }, - { - "value": "SafetyCheckInProgress", - "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1." - }, - { - "value": "SafetyCheckComplete", - "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2." - }, - { - "value": "Completed", - "description": "The task is completed. The value is 3." - } - ] - } - }, - "NodeDeactivationTask": { - "type": "object", - "description": "The task representing the deactivation operation on the node.", - "properties": { - "NodeDeactivationTaskId": { - "$ref": "#/definitions/NodeDeactivationTaskId", - "description": "Identity of the task related to deactivation operation on the node." - }, - "NodeDeactivationIntent": { - "$ref": "#/definitions/NodeDeactivationIntent", - "description": "The intent or the reason for deactivating the node. Following are the possible values for it." - } - } - }, - "NodeDeactivationTaskId": { - "type": "object", - "description": "Identity of the task related to deactivation operation on the node.", - "properties": { - "Id": { - "type": "string", - "description": "Value of the task id." - }, - "NodeDeactivationTaskType": { - "$ref": "#/definitions/NodeDeactivationTaskType", - "description": "The type of the task that performed the node deactivation. Following are the possible values." - } - } - }, - "NodeDeactivationTaskList": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeDeactivationTask" - }, - "description": "List of tasks representing the deactivation operation on the node." - }, - "NodeDeactivationTaskType": { - "type": "string", - "description": "The type of the task that performed the node deactivation. Following are the possible values.", - "enum": [ - "Invalid", - "Infrastructure", - "Repair", - "Client" - ], - "x-ms-enum": { - "name": "NodeDeactivationTaskType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." - }, - { - "value": "Infrastructure", - "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1." - }, - { - "value": "Repair", - "description": "Specifies the task that was created by the Repair Manager service. The value is 2." - }, - { - "value": "Client", - "description": "Specifies that the task was created by using the public API. The value is 3." - } - ] - } - }, - "NodeEvent": { - "description": "Represents the base for all Node Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "NodeEvent", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - } - }, - "required": [ - "NodeName" - ] - } - ], - "x-ms-discriminator-value": "NodeEvent" - }, - "NodeEventList": { - "description": "A list of NodeEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/NodeEvent" - } - }, - "NodeHealth": { - "description": "Information about the health of a Service Fabric node.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "NodeHealth", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node whose health information is described by this object." - } - } - } - ] - }, - "NodeHealthEvaluation": { - "x-ms-discriminator-value": "Node", - "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "NodeHealthEvaluation", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "NodeHealthState": { - "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "NodeHealthState", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "Id": { - "$ref": "#/definitions/NodeId", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." - } - } - } - ] - }, - "NodeHealthStateChunk": { - "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "NodeHealthStateChunk", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - } - } - } - ] - }, - "NodeHealthStateChunkList": { - "type": "object", - "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunkList" - }, - { - "type": "object", - "description": "NodeHealthStateChunkList", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeHealthStateChunk" - }, - "description": "The list of node health state chunks that respect the input filters in the chunk query." - } - } - } - ] - }, - "NodeHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.", - "properties": { - "NodeNameFilter": { - "type": "string", - "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "NodeId": { - "type": "object", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.", - "properties": { - "Id": { - "type": "string", - "description": "Value of the node Id. This is a 128 bit integer." - } - } - }, - "NodeIdList": { - "description": "A list of NodeIds.", - "type": "array", - "items": { - "$ref": "#/definitions/NodeId" - } - }, - "NodeInfo": { - "type": "object", - "description": "Information about a node in Service Fabric cluster.", - "properties": { - "Name": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "The IP address or fully qualified domain name of the node." - }, - "Type": { - "type": "string", - "description": "The type of the node." - }, - "CodeVersion": { - "type": "string", - "description": "The version of Service Fabric binaries that the node is running." - }, - "ConfigVersion": { - "type": "string", - "description": "The version of Service Fabric cluster manifest that the node is using." - }, - "NodeStatus": { - "$ref": "#/definitions/NodeStatus", - "description": "The status of the node." - }, - "NodeUpTimeInSeconds": { - "type": "string", - "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster." - }, - "UpgradeDomain": { - "type": "string", - "description": "The upgrade domain of the node." - }, - "FaultDomain": { - "type": "string", - "description": "The fault domain of the node." - }, - "Id": { - "$ref": "#/definitions/NodeId", - "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." - }, - "InstanceId": { - "type": "string", - "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts." - }, - "NodeDeactivationInfo": { - "$ref": "#/definitions/NodeDeactivationInfo", - "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated." - }, - "IsStopped": { - "type": "boolean", - "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false." - }, - "NodeDownTimeInSeconds": { - "type": "string", - "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down." - }, - "NodeUpAt": { - "type": "string", - "format": "date-time", - "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time." - }, - "NodeDownAt": { - "type": "string", - "format": "date-time", - "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time." - } - } - }, - "NodeLoadInfo": { - "type": "object", - "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "Name of the node for which the load information is provided by this object." - }, - "NodeLoadMetricInformation": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeLoadMetricInformation" - }, - "description": "List that contains metrics and their load information on this node." - } - } - }, - "NodeLoadMetricInformation": { - "type": "object", - "description": "Represents data structure that contains load information for a certain metric on a node.", - "properties": { - "Name": { - "type": "string", - "description": "Name of the metric for which this load information is provided." - }, - "NodeCapacity": { - "type": "string", - "description": "Total capacity on the node for this metric." - }, - "NodeLoad": { - "type": "string", - "description": "Current load on the node for this metric." - }, - "NodeRemainingCapacity": { - "type": "string", - "description": "The remaining capacity on the node for this metric." - }, - "IsCapacityViolation": { - "type": "boolean", - "description": "Indicates if there is a capacity violation for this metric on the node." - }, - "NodeBufferedCapacity": { - "type": "string", - "description": "The value that indicates the reserved capacity for this metric on the node." - }, - "NodeRemainingBufferedCapacity": { - "type": "string", - "description": "The remaining reserved capacity for this metric on the node." - } - } - }, - "NodeName": { - "type": "string", - "description": "The name of a Service Fabric node." - }, - "NodeType": { - "type": "string", - "description": "The type name of a Service Fabric node.\nRefer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-nodetypes) for more details." - }, - "NodesHealthEvaluation": { - "x-ms-discriminator-value": "Nodes", - "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "NodesHealthEvaluation", - "properties": { - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes found in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "NodeStatus": { - "type": "string", - "description": "The status of the node.", - "enum": [ - "Invalid", - "Up", - "Down", - "Enabling", - "Disabling", - "Disabled", - "Unknown", - "Removed" - ], - "x-ms-enum": { - "name": "NodeStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Up", - "description": "Indicates the node is up. The value is 1." - }, - { - "value": "Down", - "description": "Indicates the node is down. The value is 2." - }, - { - "value": "Enabling", - "description": "Indicates the node is in process of being enabled. The value is 3." - }, - { - "value": "Disabling", - "description": "Indicates the node is in the process of being disabled. The value is 4." - }, - { - "value": "Disabled", - "description": "Indicates the node is disabled. The value is 5." - }, - { - "value": "Unknown", - "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6." - }, - { - "value": "Removed", - "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7." - } - ] - } - }, - "NodeUpgradePhase": { - "type": "string", - "description": "The state of the upgrading node.", - "enum": [ - "Invalid", - "PreUpgradeSafetyCheck", - "Upgrading", - "PostUpgradeSafetyCheck" - ], - "x-ms-enum": { - "name": "NodeUpgradePhase", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "PreUpgradeSafetyCheck", - "description": "The upgrade has not started yet due to pending safety checks. The value is 1" - }, - { - "value": "Upgrading", - "description": "The upgrade is in progress. The value is 2" - }, - { - "value": "PostUpgradeSafetyCheck", - "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3" - } - ] - } - }, - "NodeUpgradeProgressInfo": { - "type": "object", - "description": "Information about the upgrading node and its status", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "UpgradePhase": { - "$ref": "#/definitions/NodeUpgradePhase", - "description": "The state of the upgrading node." - }, - "PendingSafetyChecks": { - "$ref": "#/definitions/SafetyCheckInfoList", - "description": "List of pending safety checks" - } - } - }, - "NodeUpgradeProgressInfoList": { - "type": "array", - "description": "List of upgrading nodes and their statuses", - "items": { - "$ref": "#/definitions/NodeUpgradeProgressInfo" - } - }, - "PagedApplicationInfoList": { - "type": "object", - "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of application information.", - "items": { - "$ref": "#/definitions/ApplicationInfo" - } - } - } - }, - "PagedDeployedApplicationInfoList": { - "type": "object", - "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of deployed application information.", - "items": { - "$ref": "#/definitions/DeployedApplicationInfo" - } - } - } - }, - "PagedNodeInfoList": { - "type": "object", - "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of node information.", - "items": { - "$ref": "#/definitions/NodeInfo" - } - } - } - }, - "PagedServicePartitionInfoList": { - "type": "object", - "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service partition information.", - "items": { - "$ref": "#/definitions/ServicePartitionInfo" - } - } - } - }, - "PagedReplicaInfoList": { - "type": "object", - "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of replica information.", - "items": { - "$ref": "#/definitions/ReplicaInfo" - } - } - } - }, - "PagedServiceInfoList": { - "type": "object", - "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service information.", - "items": { - "$ref": "#/definitions/ServiceInfo" - } - } - } - }, - "PartitionAnalysisEvent": { - "description": "Represents the base for all Partition Analysis Events.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "description": "PartitionAnalysisEvent", - "properties": { - "Metadata": { - "$ref": "#/definitions/AnalysisEventMetadata", - "description": "Metadata about an Analysis Event." - } - }, - "required": [ - "Metadata" - ] - } - ], - "x-ms-discriminator-value": "PartitionAnalysisEvent" - }, - "PartitionEvent": { - "description": "Represents the base for all Partition Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "PartitionEvent", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - }, - "required": [ - "PartitionId" - ] - } - ], - "x-ms-discriminator-value": "PartitionEvent" - }, - "PartitionEventList": { - "description": "A list of PartitionEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/PartitionEvent" - } - }, - "PartitionHealth": { - "description": "Information about the health of a Service Fabric partition.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "PartitionHealth", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "ID of the partition whose health information is described by this object." - }, - "ReplicaHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthState" - }, - "description": "The list of replica health states associated with the partition." - } - } - } - ] - }, - "PartitionHealthEvaluation": { - "x-ms-discriminator-value": "Partition", - "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "PartitionHealthEvaluation", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition whose health evaluation is described by this object." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "PartitionHealthState": { - "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "PartitionHealthState", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition whose health state is described by this object." - } - } - } - ] - }, - "PartitionHealthStateChunk": { - "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "PartitionHealthStateChunk", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "The Id of the partition." - }, - "ReplicaHealthStateChunks": { - "$ref": "#/definitions/ReplicaHealthStateChunkList", - "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "PartitionHealthStateChunkList": { - "type": "object", - "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthStateChunk" - }, - "description": "The list of partition health state chunks that respect the input filters in the chunk query." - } - } - }, - "PartitionHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.", - "properties": { - "PartitionIdFilter": { - "type": "string", - "format": "uuid", - "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "ReplicaFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthStateFilter" - }, - "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id." - } - } - }, - "PartitionId": { - "type": "string", - "format": "uuid", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "PartitionInformation": { - "type": "object", - "discriminator": "ServicePartitionKind", - "description": "Information about the partition identity, partitioning scheme and keys supported by it.", - "required": [ - "ServicePartitionKind" - ], - "properties": { - "ServicePartitionKind": { - "$ref": "#/definitions/ServicePartitionKind", - "description": "The kind of partitioning scheme used to partition the service." - }, - "Id": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - }, - "ProvisionFabricDescription": { - "type": "object", - "description": "Describes the parameters for provisioning a cluster.", - "properties": { - "CodeFilePath": { - "type": "string", - "description": "The cluster code package file path." - }, - "ClusterManifestFilePath": { - "type": "string", - "description": "The cluster manifest file path." - } - } - }, - "ProvisionApplicationTypeKind": { - "type": "string", - "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.", - "enum": [ - "Invalid", - "ImageStorePath", - "ExternalStore" - ], - "x-ms-enum": { - "name": "ProvisionApplicationTypeKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero." - }, - { - "value": "ImageStorePath", - "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1." - }, - { - "value": "ExternalStore", - "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2." - } - ] - } - }, - "ProvisionApplicationTypeDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.", - "properties": { - "Kind": { - "$ref": "#/definitions/ProvisionApplicationTypeKind", - "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision." - }, - "Async": { - "type": "boolean", - "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true." - } - }, - "required": [ - "Kind", - "Async" - ] - }, - "ProvisionApplicationTypeDescription": { - "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.", - "required": [ - "ApplicationTypeBuildPath" - ], - "allOf": [ - { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - }, - { - "type": "object", - "description": "ProvisionApplicationTypeDescription", - "properties": { - "ApplicationTypeBuildPath": { - "description": "The relative path for the application package in the image store specified during the prior upload operation.", - "type": "string" - }, - "ApplicationPackageCleanupPolicy": { - "$ref": "#/definitions/ApplicationPackageCleanupPolicy", - "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision." - } - } - } - ], - "x-ms-discriminator-value": "ImageStorePath" - }, - "ExternalStoreProvisionApplicationTypeDescription": { - "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - }, - { - "type": "object", - "description": "ExternalStoreProvisionApplicationTypeDescription", - "properties": { - "ApplicationPackageDownloadUri": { - "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.", - "type": "string" - }, - "ApplicationTypeName": { - "description": "The application type name represents the name of the application type found in the application manifest.", - "type": "string" - }, - "ApplicationTypeVersion": { - "description": "The application type version represents the version of the application type found in the application manifest.", - "type": "string" - } - } - } - ], - "x-ms-discriminator-value": "ExternalStore", - "required": [ - "ApplicationPackageDownloadUri", - "ApplicationTypeName", - "ApplicationTypeVersion" - ] - }, - "UnprovisionFabricDescription": { - "type": "object", - "description": "Describes the parameters for unprovisioning a cluster.", - "properties": { - "CodeVersion": { - "type": "string", - "description": "The cluster code package version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster manifest version." - } - } - }, - "ResumeClusterUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for resuming a cluster upgrade.", - "properties": { - "UpgradeDomain": { - "type": "string", - "description": "The next upgrade domain for this cluster upgrade." - } - }, - "required": [ - "UpgradeDomain" - ] - }, - "StartClusterUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for starting a cluster upgrade.", - "properties": { - "CodeVersion": { - "type": "string", - "description": "The cluster code version." - }, - "ConfigVersion": { - "type": "string", - "description": "The cluster configuration version." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "EnableDeltaHealthEvaluation": { - "type": "boolean", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "UpdateClusterUpgradeDescription": { - "description": "Parameters for updating a cluster upgrade.", - "properties": { - "UpgradeKind": { - "$ref": "#/definitions/UpgradeType", - "description": "The type of upgrade out of the following possible values." - }, - "UpdateDescription": { - "$ref": "#/definitions/RollingUpgradeUpdateDescription", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "EnableDeltaHealthEvaluation": { - "$ref": "#/definitions/DeltaHealthEvaluationBool", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "SafetyCheckKind": { - "type": "string", - "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.", - "enum": [ - "Invalid", - "EnsureSeedNodeQuorum", - "EnsurePartitionQuorum", - "WaitForPrimaryPlacement", - "WaitForPrimarySwap", - "WaitForReconfiguration", - "WaitForInbuildReplica", - "EnsureAvailability" - ], - "x-ms-enum": { - "name": "SafetyCheckKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "EnsureSeedNodeQuorum", - "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1." - }, - { - "value": "EnsurePartitionQuorum", - "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2." - }, - { - "value": "WaitForPrimaryPlacement", - "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3." - }, - { - "value": "WaitForPrimarySwap", - "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4." - }, - { - "value": "WaitForReconfiguration", - "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5." - }, - { - "value": "WaitForInbuildReplica", - "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6." - }, - { - "value": "EnsureAvailability", - "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7." - } - ] - } - }, - "SafetyCheck": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", - "properties": { - "Kind": { - "$ref": "#/definitions/SafetyCheckKind", - "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks." - } - }, - "required": [ - "Kind" - ] - }, - "PartitionSafetyCheck": { - "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.", - "allOf": [ - { - "$ref": "#/definitions/SafetyCheck" - }, - { - "type": "object", - "description": "PartitionSafetyCheck", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition which is undergoing the safety check." - } - } - } - ] - }, - "EnsureAvailabilitySafetyCheck": { - "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "EnsureAvailabilitySafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsureAvailability" - }, - "EnsurePartitionQurumSafetyCheck": { - "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "EnsurePartitionQurumSafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsurePartitionQuorum" - }, - "SeedNodeSafetyCheck": { - "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.", - "allOf": [ - { - "$ref": "#/definitions/SafetyCheck" - }, - { - "type": "object", - "description": "SeedNodeSafetyCheck" - } - ], - "x-ms-discriminator-value": "EnsureSeedNodeQuorum" - }, - "PartitionsHealthEvaluation": { - "x-ms-discriminator-value": "Partitions", - "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "PartitionsHealthEvaluation", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of partitions of the service from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ReplicaEvent": { - "description": "Represents the base for all Replica Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ReplicaEvent", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "ReplicaId": { - "$ref": "#/definitions/ReplicaId_Integer", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - }, - "required": [ - "PartitionId", - "ReplicaId" - ] - } - ], - "x-ms-discriminator-value": "ReplicaEvent" - }, - "ReplicaEventList": { - "description": "A list of ReplicaEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaEvent" - } - }, - "ReplicaHealth": { - "discriminator": "ServiceKind", - "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ReplicaHealth", - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition to which this replica belongs." - } - }, - "required": [ - "ServiceKind" - ] - } - ] - }, - "ReplicaHealthEvaluation": { - "x-ms-discriminator-value": "Replica", - "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ReplicaHealthEvaluation", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition to which the replica belongs." - }, - "ReplicaOrInstanceId": { - "$ref": "#/definitions/ReplicaOrInstanceId", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation." - } - } - } - ] - }, - "ReplicaHealthState": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "description": "Represents a base class for stateful service replica or stateless service instance health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ReplicaHealthState", - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "The ID of the partition to which this replica belongs." - } - } - } - ] - }, - "ReplicaHealthStateChunk": { - "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ReplicaHealthStateChunk", - "properties": { - "ReplicaOrInstanceId": { - "$ref": "#/definitions/ReplicaOrInstanceId", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - } - } - } - ] - }, - "ReplicaHealthStateChunkList": { - "type": "object", - "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ReplicaHealthStateChunk" - }, - "description": "The list of replica health state chunks that respect the input filters in the chunk query." - } - } - }, - "ReplicaHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.", - "properties": { - "ReplicaOrInstanceIdFilter": { - "type": "string", - "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - } - } - }, - "ReplicaId": { - "type": "string", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaId_Integer": { - "type": "integer", - "format": "int64", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "ReplicaOrInstanceId": { - "type": "string", - "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." - }, - "ReplicaInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ReplicaStatus": { - "$ref": "#/definitions/ReplicaStatus", - "description": "The status of a replica of a service." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "Address": { - "type": "string", - "description": "The address the replica is listening on." - }, - "LastInBuildDurationInSeconds": { - "type": "string", - "description": "The last in build duration of the replica in seconds." - } - } - }, - "ReplicaRole": { - "type": "string", - "description": "The role of a replica of a stateful service.", - "enum": [ - "Unknown", - "None", - "Primary", - "IdleSecondary", - "ActiveSecondary" - ], - "x-ms-enum": { - "name": "ReplicaRole", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the initial role that a replica is created in. The value is zero." - }, - { - "value": "None", - "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1" - }, - { - "value": "Primary", - "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2." - }, - { - "value": "IdleSecondary", - "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3." - }, - { - "value": "ActiveSecondary", - "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4." - } - ] - } - }, - "ReplicasHealthEvaluation": { - "x-ms-discriminator-value": "Replicas", - "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ReplicasHealthEvaluation", - "properties": { - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of replicas in the partition from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ReplicaStatus": { - "type": "string", - "description": "The status of a replica of a service.", - "enum": [ - "Invalid", - "InBuild", - "Standby", - "Ready", - "Down", - "Dropped" - ], - "x-ms-enum": { - "name": "ReplicaStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "InBuild", - "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1." - }, - { - "value": "Standby", - "description": "The replica is in standby. The value is 2." - }, - { - "value": "Ready", - "description": "The replica is ready. The value is 3." - }, - { - "value": "Down", - "description": "The replica is down. The value is 4." - }, - { - "value": "Dropped", - "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5." - } - ] - } - }, - "RestartNodeDescription": { - "description": "Describes the parameters to restart a Service Fabric node.", - "properties": { - "NodeInstanceId": { - "type": "string", - "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.", - "default": "0" - }, - "CreateFabricDump": { - "type": "string", - "description": "Specify True to create a dump of the fabric node process. This is case-sensitive.", - "enum": [ - "False", - "True" - ], - "default": "False", - "x-ms-enum": { - "name": "CreateFabricDump", - "modelAsString": true, - "values": [ - { - "value": "False" - }, - { - "value": "True" - } - ] - } - } - }, - "required": [ - "NodeInstanceId" - ] - }, - "SafetyCheckInfoList": { - "type": "array", - "description": "List of pending safety checks", - "items": { - "$ref": "#/definitions/SafetyCheckWrapper" - } - }, - "SafetyCheckWrapper": { - "type": "object", - "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", - "properties": { - "SafetyCheck": { - "$ref": "#/definitions/SafetyCheck", - "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state." - } - } - }, - "ServiceEvent": { - "description": "Represents the base for all Service Events.", - "allOf": [ - { - "$ref": "#/definitions/FabricEvent" - }, - { - "type": "object", - "description": "ServiceEvent", - "properties": { - "ServiceId": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - } - }, - "required": [ - "ServiceId" - ] - } - ], - "x-ms-discriminator-value": "ServiceEvent" - }, - "ServiceEventList": { - "description": "A list of ServiceEvent objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceEvent" - } - }, - "ServiceFromTemplateDescription": { - "type": "object", - "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.", - "required": [ - "ApplicationName", - "ServiceName", - "ServiceTypeName" - ], - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "InitializationData": { - "$ref": "#/definitions/ByteArray", - "description": "The initialization data for the newly created service instance." - }, - "ServicePackageActivationMode": { - "$ref": "#/definitions/ServicePackageActivationMode", - "description": "The activation mode of service package to be used for a service." - }, - "ServiceDnsName": { - "type": "string", - "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." - } - } - }, - "ServiceHealthEvaluation": { - "x-ms-discriminator-value": "Service", - "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ServiceHealthEvaluation", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Name of the service whose health evaluation is described by this object." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "ServiceHealthState": { - "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthState" - }, - { - "type": "object", - "description": "ServiceHealthState", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Name of the service whose health state is represented by this object." - } - } - } - ] - }, - "ServiceHealthStateChunk": { - "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealthStateChunk" - }, - { - "type": "object", - "description": "ServiceHealthStateChunk", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service whose health state chunk is provided in this object." - }, - "PartitionHealthStateChunks": { - "$ref": "#/definitions/PartitionHealthStateChunkList", - "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description." - } - } - } - ] - }, - "ServiceHealthStateChunkList": { - "type": "object", - "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", - "properties": { - "Items": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceHealthStateChunk" - }, - "description": "The list of service health state chunks that respect the input filters in the chunk query." - } - } - }, - "ServiceHealthStateFilter": { - "type": "object", - "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.", - "properties": { - "ServiceNameFilter": { - "type": "string", - "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." - }, - "HealthStateFilter": { - "type": "integer", - "default": 0, - "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." - }, - "PartitionFilters": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthStateFilter" - }, - "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID." - } - } - }, - "ServiceHealth": { - "description": "Information about the health of a Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/EntityHealth" - }, - { - "type": "object", - "description": "ServiceHealth", - "properties": { - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service whose health information is described by this object." - }, - "PartitionHealthStates": { - "type": "array", - "items": { - "$ref": "#/definitions/PartitionHealthState" - }, - "description": "The list of partition health states associated with the service." - } - } - } - ] - }, - "ServiceId": { - "type": "string", - "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceName": { - "type": "string", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceManifestName": { - "type": "string", - "description": "The name of the service manifest." - }, - "ServiceTypeName": { - "type": "string", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service.", - "properties": { - "Id": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ManifestVersion": { - "description": "The version of the service manifest.", - "type": "string" - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "ServiceStatus": { - "$ref": "#/definitions/ServiceStatus", - "description": "The status of the application." - }, - "IsServiceGroup": { - "description": "Whether the service is in a service group.", - "type": "boolean" - } - }, - "required": [ - "ServiceKind" - ] - }, - "ServiceKind": { - "type": "string", - "description": "The kind of service (Stateless or Stateful).", - "enum": [ - "Invalid", - "Stateless", - "Stateful" - ], - "x-ms-enum": { - "name": "ServiceKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Stateless", - "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." - }, - { - "value": "Stateful", - "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." - } - ] - } - }, - "ServiceNameInfo": { - "type": "object", - "description": "Information about the service name.", - "properties": { - "Id": { - "$ref": "#/definitions/ServiceId", - "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - }, - "ServicePackageActivationId": { - "type": "string", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "ServicePartitionInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a partition of a Service Fabric service.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "HealthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "PartitionStatus": { - "$ref": "#/definitions/ServicePartitionStatus", - "description": "The status of the service fabric service partition." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "Information about the partition identity, partitioning scheme and keys supported by it." - } - } - }, - "ServicePartitionKind": { - "type": "string", - "description": "The kind of partitioning scheme used to partition the service.", - "enum": [ - "Invalid", - "Singleton", - "Int64Range", - "Named" - ], - "x-ms-enum": { - "name": "ServicePartitionKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Singleton", - "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1." - }, - { - "value": "Int64Range", - "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2." - }, - { - "value": "Named", - "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3." - } - ] - } - }, - "ServicePartitionStatus": { - "type": "string", - "description": "The status of the service fabric service partition.", - "enum": [ - "Invalid", - "Ready", - "NotReady", - "InQuorumLoss", - "Reconfiguring", - "Deleting" - ], - "x-ms-enum": { - "name": "ServicePartitionStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ready", - "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1." - }, - { - "value": "NotReady", - "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2." - }, - { - "value": "InQuorumLoss", - "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3." - }, - { - "value": "Reconfiguring", - "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4." - }, - { - "value": "Deleting", - "description": "Indicates that the partition is being deleted. The value is 5." - } - ] - } - }, - "ServicePlacementInvalidDomainPolicyDescription": { - "x-ms-discriminator-value": "InvalidDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementInvalidDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should not be used for placement." - } - } - } - ] - }, - "ServicePlacementNonPartiallyPlaceServicePolicyDescription": { - "x-ms-discriminator-value": "NonPartiallyPlaceService", - "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementNonPartiallyPlaceServicePolicyDescription" - } - ] - }, - "ServicePlacementPolicyDescription": { - "type": "object", - "discriminator": "Type", - "description": "Describes the policy to be used for placement of a Service Fabric service.", - "required": [ - "Type" - ], - "properties": { - "Type": { - "$ref": "#/definitions/ServicePlacementPolicyType", - "description": "The type of placement policy for a service fabric service. Following are the possible values." - } - } - }, - "ServicePlacementPolicyDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "List of service placement policy descriptions." - }, - "ServicePlacementPolicyType": { - "type": "string", - "description": "The type of placement policy for a service fabric service. Following are the possible values.", - "enum": [ - "Invalid", - "InvalidDomain", - "RequiredDomain", - "PreferredPrimaryDomain", - "RequiredDomainDistribution", - "NonPartiallyPlaceService" - ], - "x-ms-enum": { - "name": "ServicePlacementPolicyType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "InvalidDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." - }, - { - "value": "RequiredDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." - }, - { - "value": "PreferredPrimaryDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." - }, - { - "value": "RequiredDomainDistribution", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." - }, - { - "value": "NonPartiallyPlaceService", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." - } - ] - } - }, - "ServicePlacementPreferPrimaryDomainPolicyDescription": { - "x-ms-discriminator-value": "PreferredPrimaryDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementPreferPrimaryDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicePlacementRequiredDomainPolicyDescription": { - "x-ms-discriminator-value": "RequiredDomain", - "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementRequiredDomainPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicePlacementRequireDomainDistributionPolicyDescription": { - "x-ms-discriminator-value": "RequiredDomainDistribution", - "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.", - "allOf": [ - { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - { - "type": "object", - "description": "ServicePlacementRequireDomainDistributionPolicyDescription", - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the domain that should used for placement as per this policy." - } - } - } - ] - }, - "ServicesHealthEvaluation": { - "x-ms-discriminator-value": "Services", - "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "ServicesHealthEvaluation", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Name of the service type of the services." - }, - "MaxPercentUnhealthyServices": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of services of the current service type in the application from the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "ServiceStatus": { - "type": "string", - "description": "The status of the application.", - "enum": [ - "Unknown", - "Active", - "Upgrading", - "Deleting", - "Creating", - "Failed" - ], - "x-ms-enum": { - "name": "ServiceStatus", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the service status is unknown. The value is zero." - }, - { - "value": "Active", - "description": "Indicates the service status is active. The value is 1." - }, - { - "value": "Upgrading", - "description": "Indicates the service is upgrading. The value is 2." - }, - { - "value": "Deleting", - "description": "Indicates the service is being deleted. The value is 3." - }, - { - "value": "Creating", - "description": "Indicates the service is being created. The value is 4." - }, - { - "value": "Failed", - "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5." - } - ] - } - }, - "ServiceTypeDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster." - }, - "LoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPolicyDescriptionList", - "description": "List of service placement policy descriptions." - }, - "Extensions": { - "$ref": "#/definitions/ServiceTypeExtensionDescriptionList", - "description": "List of service type extensions." - } - } - }, - "ServiceTypeExtensionDescription": { - "type": "object", - "description": "Describes extension of a service type defined in the service manifest.", - "properties": { - "Key": { - "type": "string", - "description": "The name of the extension." - }, - "Value": { - "type": "string", - "description": "The extension value." - } - } - }, - "ServiceTypeExtensionDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeExtensionDescription" - }, - "description": "List of service type extensions." - }, - "ServiceTypeHealthPolicy": { - "type": "object", - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.", - "default": 0 - }, - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.", - "default": 0 - }, - "MaxPercentUnhealthyServices": { - "type": "integer", - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", - "default": 0 - } - } - }, - "ServiceTypeHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" - }, - "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation." - }, - "ServiceTypeHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ServiceTypeHealthPolicyMap.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key of the service type health policy map item. This is the name of the service type." - }, - "Value": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type." - } - } - }, - "ServiceTypeInfo": { - "type": "object", - "description": "Information about a service type that is defined in a service manifest of a provisioned application type.", - "properties": { - "ServiceTypeDescription": { - "$ref": "#/definitions/ServiceTypeDescription", - "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "ServiceManifestVersion": { - "type": "string", - "description": "The version of the service manifest in which this service type is defined." - }, - "IsServiceGroup": { - "type": "boolean", - "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false." - } - } - }, - "ServiceTypeInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeInfo" - }, - "description": "List of service type information." - }, - "ServiceTypeManifest": { - "type": "object", - "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.", - "properties": { - "Manifest": { - "type": "string", - "description": "The XML manifest as a string." - } - } - }, - "SingletonPartitionInformation": { - "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionInformation" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "StatefulServiceInfo": { - "description": "Information about a stateful Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceInfo" - }, - { - "type": "object", - "description": "StatefulService", - "properties": { - "HasPersistedState": { - "description": "Whether the service has persisted state.", - "type": "boolean" - } - } - } - ], - "x-ms-discriminator-value": "Stateful" - }, - "StatefulServicePartitionInfo": { - "description": "Information about a partition of a stateful Service Fabric service..", - "allOf": [ - { - "$ref": "#/definitions/ServicePartitionInfo" - }, - { - "type": "object", - "description": "StatefulServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "format": "int64", - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int64", - "description": "The minimum replica set size as a number." - }, - "LastQuorumLossDuration": { - "type": "string", - "format": "duration", - "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration." - }, - "CurrentConfigurationEpoch": { - "$ref": "#/definitions/Epoch", - "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica." - } - } - }, - "StatefulServiceReplicaHealth": { - "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealth" - }, - { - "type": "object", - "description": "StatefulServiceReplicaHealth", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatefulServiceReplicaHealthState": { - "x-ms-discriminator-value": "Stateful", - "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealthState" - }, - { - "type": "object", - "description": "StatefulServiceReplicaHealthState", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatefulServiceTypeDescription": { - "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.", - "allOf": [ - { - "$ref": "#/definitions/ServiceTypeDescription" - }, - { - "type": "object", - "description": "StatefulServiceTypeDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "HasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - } - } - }, - "StatelessServiceInfo": { - "description": "Information about a stateless Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceInfo" - }, - { - "type": "object", - "description": "StatelessService" - } - ], - "x-ms-discriminator-value": "Stateless" - }, - "StatelessServiceInstanceHealth": { - "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealth" - }, - { - "type": "object", - "description": "StatelessServiceInstanceHealth", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "StatelessServiceInstanceHealthState": { - "x-ms-discriminator-value": "Stateless", - "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaHealthState" - }, - { - "type": "object", - "description": "StatelessServiceInstanceHealthState", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of the stateless service instance on the wire this field is called ReplicaId." - } - } - } - ] - }, - "StatelessServicePartitionInfo": { - "description": "Information about a partition of a stateless Service Fabric service.", - "allOf": [ - { - "$ref": "#/definitions/ServicePartitionInfo" - }, - { - "type": "object", - "description": "StatelessServicePartitionInfo" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "InstanceCount": { - "type": "integer", - "format": "int64", - "description": "Number of instances of this partition." - } - } - }, - "StatelessServiceTypeDescription": { - "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", - "allOf": [ - { - "$ref": "#/definitions/ServiceTypeDescription" - }, - { - "type": "object", - "description": "StatelessServiceTypeDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "UseImplicitHost": { - "type": "boolean", - "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise." - } - } - }, - "SystemApplicationHealthEvaluation": { - "x-ms-discriminator-value": "SystemApplication", - "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "SystemApplicationHealthEvaluation", - "properties": { - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." - } - } - } - ] - }, - "TargetApplicationName": { - "type": "string", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "TargetApplicationTypeVersion": { - "type": "string", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "TargetDeploymentName": { - "type": "string", - "description": "The name of the target deployment." - }, - "UnhealthyEvaluations": { - "description": "List of health evaluations that resulted in the current aggregated health state.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvaluationWrapper" - } - }, - "UpgradeDomainDeltaNodesCheckHealthEvaluation": { - "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck", - "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "UpgradeDomainDeltaNodesCheckHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "Name of the upgrade domain where nodes health is currently evaluated." - }, - "BaselineErrorCount": { - "type": "integer", - "format": "int64", - "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." - }, - "BaselineTotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade." - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of upgrade domain nodes in the health store." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "UpgradeDomainInfo": { - "type": "object", - "description": "Information about an upgrade domain.", - "properties": { - "Name": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "State": { - "$ref": "#/definitions/UpgradeDomainState", - "description": "The state of the upgrade domain." - } - } - }, - "UpgradeDomainInfoList": { - "type": "array", - "description": "List of upgrade domains and their statuses.", - "items": { - "$ref": "#/definitions/UpgradeDomainInfo" - } - }, - "UpgradeDomainName": { - "type": "string", - "description": "The name of the upgrade domain" - }, - "UpgradeDomainNodesHealthEvaluation": { - "x-ms-discriminator-value": "UpgradeDomainNodes", - "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - }, - { - "type": "object", - "description": "UpgradeDomainNodesHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "Name of the upgrade domain where nodes health is currently evaluated." - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." - }, - "TotalCount": { - "type": "integer", - "format": "int64", - "description": "Total number of nodes in the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." - } - } - } - ] - }, - "UpgradeDomainState": { - "type": "string", - "description": "The state of the upgrade domain.", - "enum": [ - "Invalid", - "Pending", - "InProgress", - "Completed" - ], - "x-ms-enum": { - "name": "UpgradeDomainState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Pending", - "description": "The upgrade domain has not started upgrading yet. The value is 1" - }, - { - "value": "InProgress", - "description": "The upgrade domain is being upgraded but not complete yet. The value is 2" - }, - { - "value": "Completed", - "description": "The upgrade domain has completed upgrade. The value is 3" - } - ] - } - }, - "UpgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeDuration": { - "type": "string", - "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "UpgradeKind": { - "type": "string", - "description": "The kind of upgrade out of the following possible values.", - "default": "Rolling", - "enum": [ - "Invalid", - "Rolling" - ], - "x-ms-enum": { - "name": "UpgradeKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rolling", - "description": "The upgrade progresses one upgrade domain at a time. The value is 1" - } - ] - } - }, - "UpgradeMode": { - "type": "string", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.", - "enum": [ - "Invalid", - "UnmonitoredAuto", - "UnmonitoredManual", - "Monitored" - ], - "default": "UnmonitoredAuto", - "x-ms-enum": { - "name": "UpgradeMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "UnmonitoredAuto", - "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1" - }, - { - "value": "UnmonitoredManual", - "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2" - }, - { - "value": "Monitored", - "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3" - } - ] - } - }, - "UpgradeType": { - "type": "string", - "description": "The type of upgrade out of the following possible values.", - "default": "Rolling", - "enum": [ - "Invalid", - "Rolling", - "Rolling_ForceRestart" - ], - "x-ms-enum": { - "name": "UpgradeType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Rolling", - "description": "The upgrade progresses one upgrade domain at a time. The value is 1." - }, - { - "value": "Rolling_ForceRestart", - "description": "The upgrade gets restarted by force. The value is 2." - } - ] - } - }, - "UpgradeReplicaSetCheckTimeout": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", - "default": 42949672925 - }, - "UpgradeState": { - "type": "string", - "description": "The state of the upgrade domain.", - "enum": [ - "Invalid", - "RollingBackInProgress", - "RollingBackCompleted", - "RollingForwardPending", - "RollingForwardInProgress", - "RollingForwardCompleted", - "Failed" - ], - "x-ms-enum": { - "name": "UpgradeState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "RollingBackInProgress", - "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1" - }, - { - "value": "RollingBackCompleted", - "description": "The upgrade has finished rolling back. The value is 2" - }, - { - "value": "RollingForwardPending", - "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" - }, - { - "value": "RollingForwardInProgress", - "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4" - }, - { - "value": "RollingForwardCompleted", - "description": "The upgrade has finished rolling forward. The value is 5" - }, - { - "value": "Failed", - "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6" - } - ] - } - }, - "UpgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "WaitForInbuildReplicaSafetyCheck": { - "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForInbuildReplicaSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForInbuildReplica" - }, - "WaitForPrimaryPlacementSafetyCheck": { - "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForPrimaryPlacementSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForPrimaryPlacement" - }, - "WaitForPrimarySwapSafetyCheck": { - "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForPrimarySwapSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForPrimarySwap" - }, - "WaitForReconfigurationSafetyCheck": { - "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSafetyCheck" - }, - { - "type": "object", - "description": "WaitForReconfigurationSafetyCheck" - } - ], - "x-ms-discriminator-value": "WaitForReconfiguration" - }, - "LoadMetricReport": { - "type": "object", - "description": "Represents the load metric report which contains the time metric was reported, its name and value.", - "properties": { - "LastReportedUtc": { - "type": "string", - "format": "date-time", - "description": "Gets the UTC time when the load was reported." - }, - "Name": { - "type": "string", - "description": "The name of the load metric." - }, - "Value": { - "type": "string", - "format": "int32", - "description": "The value of the load metric." - } - } - }, - "PartitionLoadInformation": { - "type": "object", - "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.", - "properties": { - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "Id of the partition." - }, - "PrimaryLoadMetricReports": { - "type": "array", - "description": "Array of load reports from the primary replica for this partition.", - "items": { - "$ref": "#/definitions/LoadMetricReport" - } - }, - "SecondaryLoadMetricReports": { - "type": "array", - "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.", - "items": { - "$ref": "#/definitions/LoadMetricReport" - } - } - } - }, - "StatefulServiceReplicaInfo": { - "x-ms-discriminator-value": "Stateful", - "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaInfo" - }, - { - "type": "object", - "description": "StatefulServiceReplicaInfo", - "properties": { - "ReplicaRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - }, - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - } - } - } - ] - }, - "StatelessServiceInstanceInfo": { - "x-ms-discriminator-value": "Stateless", - "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaInfo" - }, - { - "type": "object", - "description": "StatelessServiceInstanceInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - } - } - } - ] - }, - "ClusterFabricCodeVersionString": { - "type": "string", - "description": "The ServiceFabric code version of the cluster." - }, - "ClusterFabricConfigVersionString": { - "type": "string", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "ClusterUpgradeDescriptionObject": { - "type": "object", - "description": "Represents a ServiceFabric cluster upgrade", - "properties": { - "ConfigVersion": { - "$ref": "#/definitions/ClusterFabricConfigVersionString", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "CodeVersion": { - "$ref": "#/definitions/ClusterFabricCodeVersionString", - "description": "The ServiceFabric code version of the cluster." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "EnableDeltaHealthEvaluation": { - "$ref": "#/definitions/DeltaHealthEvaluationBool", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "ClusterUpgradeHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." - }, - "ApplicationHealthPolicyMap": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." - } - } - }, - "ClusterUpgradeHealthPolicyObject": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.", - "properties": { - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.", - "maximum": 100, - "minimum": 0 - }, - "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.", - "maximum": 100, - "minimum": 0 - } - } - }, - "ClusterUpgradeProgressObject": { - "type": "object", - "description": "Information about a cluster upgrade.", - "properties": { - "CodeVersion": { - "$ref": "#/definitions/ClusterFabricCodeVersionString", - "description": "The ServiceFabric code version of the cluster." - }, - "ConfigVersion": { - "$ref": "#/definitions/ClusterFabricConfigVersionString", - "description": "The cluster configuration version (specified in the cluster manifest)." - }, - "UpgradeDomains": { - "$ref": "#/definitions/UpgradeDomainInfoList", - "description": "List of upgrade domains and their statuses." - }, - "UpgradeState": { - "$ref": "#/definitions/UpgradeState", - "description": "The state of the upgrade domain." - }, - "NextUpgradeDomain": { - "$ref": "#/definitions/NextUpgradeDomain", - "description": "The name of the next upgrade domain to be processed." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeDescription": { - "$ref": "#/definitions/ClusterUpgradeDescriptionObject", - "description": "Represents a ServiceFabric cluster upgrade" - }, - "UpgradeDurationInMilliseconds": { - "$ref": "#/definitions/UpgradeDurationString", - "description": "The estimated elapsed time spent processing the current overall upgrade." - }, - "UpgradeDomainDurationInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainDurationString", - "description": "The estimated elapsed time spent processing the current upgrade domain." - }, - "UnhealthyEvaluations": { - "$ref": "#/definitions/UnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "$ref": "#/definitions/UpgradeStartTimeUTCString", - "description": "The start time of the upgrade in UTC." - }, - "FailureTimestampUtc": { - "$ref": "#/definitions/UpgradeFailureTimeUTCString", - "description": "The failure time of the upgrade in UTC." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailedUpgradeDomainProgressObject", - "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure." - } - } - }, - "ClusterConfigurationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for a standalone cluster configuration upgrade.", - "properties": { - "ClusterConfig": { - "type": "string", - "description": "The cluster configuration." - }, - "HealthCheckRetryTimeout": { - "type": "string", - "format": "duration", - "description": "The length of time between attempts to perform a health checks if the application or cluster is not healthy.", - "default": "PT0H0M0S" - }, - "HealthCheckWaitDurationInSeconds": { - "type": "string", - "format": "duration", - "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.", - "default": "PT0H0M0S" - }, - "HealthCheckStableDurationInSeconds": { - "type": "string", - "format": "duration", - "description": "The length of time that the application or cluster must remain healthy.", - "default": "PT0H0M0S" - }, - "UpgradeDomainTimeoutInSeconds": { - "type": "string", - "format": "duration", - "description": "The timeout for the upgrade domain.", - "default": "PT0H0M0S" - }, - "UpgradeTimeoutInSeconds": { - "type": "string", - "format": "duration", - "description": "The upgrade timeout.", - "default": "PT0H0M0S" - }, - "MaxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", - "default": 0 - }, - "ApplicationHealthPolicies": { - "$ref": "#/definitions/ApplicationHealthPolicies", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - }, - "required": [ - "ClusterConfig" - ] - }, - "DeltaHealthEvaluationBool": { - "type": "boolean", - "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." - }, - "FailedUpgradeDomainProgressObject": { - "type": "object", - "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.", - "properties": { - "DomainName": { - "$ref": "#/definitions/UpgradeDomainName", - "description": "The name of the upgrade domain" - }, - "NodeUpgradeProgressList": { - "$ref": "#/definitions/NodeUpgradeProgressInfoList", - "description": "List of upgrading nodes and their statuses" - } - } - }, - "UpgradeDomainDurationString": { - "type": "string", - "description": "The estimated elapsed time spent processing the current upgrade domain." - }, - "UpgradeDurationString": { - "type": "string", - "description": "The estimated elapsed time spent processing the current overall upgrade." - }, - "UpgradeFailureTimeUTCString": { - "type": "string", - "description": "The failure time of the upgrade in UTC." - }, - "UpgradeStartTimeUTCString": { - "type": "string", - "description": "The start time of the upgrade in UTC." - }, - "UpgradeOrchestrationServiceState": { - "type": "object", - "description": "Service state of Service Fabric Upgrade Orchestration Service.", - "properties": { - "ServiceState": { - "type": "string", - "description": "The state of Service Fabric Upgrade Orchestration Service." - } - } - }, - "UpgradeOrchestrationServiceStateSummary": { - "type": "object", - "description": "Service state summary of Service Fabric Upgrade Orchestration Service.", - "properties": { - "CurrentCodeVersion": { - "type": "string", - "description": "The current code version of the cluster." - }, - "CurrentManifestVersion": { - "type": "string", - "description": "The current manifest version of the cluster." - }, - "TargetCodeVersion": { - "type": "string", - "description": "The target code version of the cluster." - }, - "TargetManifestVersion": { - "type": "string", - "description": "The target manifest version of the cluster." - }, - "PendingUpgradeType": { - "type": "string", - "description": "The type of the pending upgrade of the cluster." - } - } - }, - "ApplicationTypeImageStorePath": { - "description": "Path description for the application package in the image store specified during the prior copy operation.", - "required": [ - "ApplicationTypeBuildPath" - ], - "properties": { - "ApplicationTypeBuildPath": { - "type": "string", - "description": "The relative image store path to the application package." - } - } - }, - "UnprovisionApplicationTypeDescriptionInfo": { - "type": "object", - "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.", - "required": [ - "ApplicationTypeVersion" - ], - "properties": { - "ApplicationTypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "Async": { - "type": "boolean", - "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned." - } - } - }, - "CodePackageName": { - "type": "string", - "description": "The name of the code package defined in the service manifest." - }, - "CodePackageEntryPointStatistics": { - "type": "object", - "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.", - "properties": { - "LastExitCode": { - "type": "string", - "description": "The last exit code of the entry point." - }, - "LastActivationTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when Service Fabric attempted to run the entry point." - }, - "LastExitTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point finished running." - }, - "LastSuccessfulActivationTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point ran successfully." - }, - "LastSuccessfulExitTime": { - "type": "string", - "format": "date-time", - "description": "The last time (in UTC) when the entry point finished running gracefully." - }, - "ActivationCount": { - "type": "string", - "description": "Number of times the entry point has run." - }, - "ActivationFailureCount": { - "type": "string", - "description": "Number of times the entry point failed to run." - }, - "ContinuousActivationFailureCount": { - "type": "string", - "description": "Number of times the entry point continuously failed to run." - }, - "ExitCount": { - "type": "string", - "description": "Number of times the entry point finished running." - }, - "ExitFailureCount": { - "type": "string", - "description": "Number of times the entry point failed to exit gracefully." - }, - "ContinuousExitFailureCount": { - "type": "string", - "description": "Number of times the entry point continuously failed to exit gracefully." - } - } - }, - "DeployedCodePackageInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedCodePackageInfo" - }, - "description": "List of deployed code package information." - }, - "DeployedCodePackageInfo": { - "type": "object", - "description": "Information about code package deployed on a Service Fabric node.", - "properties": { - "Name": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package." - }, - "Version": { - "type": "string", - "description": "The version of the code package specified in service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest that specified this code package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "HostType": { - "$ref": "#/definitions/HostType", - "description": "Specifies the type of host for main entry point of a code package as specified in service manifest." - }, - "HostIsolationMode": { - "$ref": "#/definitions/HostIsolationMode", - "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest." - }, - "Status": { - "$ref": "#/definitions/DeploymentStatus", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node." - }, - "RunFrequencyInterval": { - "type": "string", - "description": "The interval at which code package is run. This is used for periodic code package." - }, - "SetupEntryPoint": { - "$ref": "#/definitions/CodePackageEntryPoint", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." - }, - "MainEntryPoint": { - "$ref": "#/definitions/CodePackageEntryPoint", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." - } - } - }, - "DeploymentStatus": { - "type": "string", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node.", - "enum": [ - "Invalid", - "Downloading", - "Activating", - "Active", - "Upgrading", - "Deactivating" - ], - "x-ms-enum": { - "name": "DeploymentStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates status of the application or service package is not known or invalid. The value is 0." - }, - { - "value": "Downloading", - "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1." - }, - { - "value": "Activating", - "description": "Indicates the application or service package is being activated. The value is 2." - }, - { - "value": "Active", - "description": "Indicates the application or service package is active the node. The value is 3." - }, - { - "value": "Upgrading", - "description": "Indicates the application or service package is being upgraded. The value is 4." - }, - { - "value": "Deactivating", - "description": "Indicates the application or service package is being deactivated. The value is 5." - } - ] - } - }, - "EntryPointStatus": { - "type": "string", - "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.", - "enum": [ - "Invalid", - "Pending", - "Starting", - "Started", - "Stopping", - "Stopped" - ], - "x-ms-enum": { - "name": "EntryPointStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates status of entry point is not known or invalid. The value is 0." - }, - { - "value": "Pending", - "description": "Indicates the entry point is scheduled to be started. The value is 1." - }, - { - "value": "Starting", - "description": "Indicates the entry point is being started. The value is 2." - }, - { - "value": "Started", - "description": "Indicates the entry point was started successfully and is running. The value is 3." - }, - { - "value": "Stopping", - "description": "Indicates the entry point is being stopped. The value is 4." - }, - { - "value": "Stopped", - "description": "Indicates the entry point is not running. The value is 5." - } - ] - } - }, - "CodePackageEntryPoint": { - "type": "object", - "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.", - "properties": { - "EntryPointLocation": { - "type": "string", - "description": "The location of entry point executable on the node." - }, - "ProcessId": { - "type": "string", - "description": "The process ID of the entry point." - }, - "RunAsUserName": { - "type": "string", - "description": "The user name under which entry point executable is run on the node." - }, - "CodePackageEntryPointStatistics": { - "$ref": "#/definitions/CodePackageEntryPointStatistics", - "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node." - }, - "Status": { - "$ref": "#/definitions/EntryPointStatus", - "description": "Specifies the status of the code package entry point deployed on a Service Fabric node." - }, - "NextActivationTime": { - "type": "string", - "format": "date-time", - "description": "The time (in UTC) when the entry point executable will be run next." - }, - "InstanceId": { - "$ref": "#/definitions/CodePackageInstanceId", - "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." - } - } - }, - "Chaos": { - "type": "object", - "description": "Contains a description of Chaos.", - "properties": { - "ChaosParameters": { - "$ref": "#/definitions/ChaosParameters", - "description": "If Chaos is running, these are the parameters Chaos is running with." - }, - "Status": { - "$ref": "#/definitions/ChaosStatus", - "description": "Current status of the Chaos run." - }, - "ScheduleStatus": { - "$ref": "#/definitions/ChaosScheduleStatus", - "description": "Current status of the schedule." - } - } - }, - "ChaosStatus": { - "type": "string", - "description": "Current status of the Chaos run.", - "enum": [ - "Invalid", - "Running", - "Stopped" - ], - "x-ms-enum": { - "name": "ChaosStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." - }, - { - "value": "Running", - "description": "Indicates that Chaos is not stopped. The value is one." - }, - { - "value": "Stopped", - "description": "Indicates that Chaos is not scheduling further faults. The value is two." - } - ] - } - }, - "ChaosScheduleStatus": { - "type": "string", - "description": "Current status of the schedule.", - "enum": [ - "Invalid", - "Stopped", - "Active", - "Expired", - "Pending" - ], - "x-ms-enum": { - "name": "ChaosScheduleStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." - }, - { - "value": "Stopped", - "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one." - }, - { - "value": "Active", - "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two." - }, - { - "value": "Expired", - "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three." - }, - { - "value": "Pending", - "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four." - } - ] - } - }, - "ChaosContextMap": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Describes a map that contains a collection of ChaosContextMapItem's." - }, - "ChaosContext": { - "type": "object", - "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.", - "properties": { - "Map": { - "$ref": "#/definitions/ChaosContextMap", - "description": "Describes a map that contains a collection of ChaosContextMapItem's." - } - } - }, - "ChaosParameters": { - "type": "object", - "description": "Defines all the parameters to configure a Chaos run.", - "properties": { - "TimeToRunInSeconds": { - "type": "string", - "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).", - "default": "4294967295" - }, - "MaxClusterStabilizationTimeoutInSeconds": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.", - "default": 60, - "minimum": 0, - "maximum": 4294967295 - }, - "MaxConcurrentFaults": { - "type": "integer", - "format": "int64", - "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.", - "default": 1, - "minimum": 0, - "maximum": 4294967295 - }, - "EnableMoveReplicaFaults": { - "type": "boolean", - "description": "Enables or disables the move primary and move secondary faults.", - "default": true - }, - "WaitTimeBetweenFaultsInSeconds": { - "type": "integer", - "format": "int64", - "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.", - "default": 20, - "minimum": 0, - "maximum": 4294967295 - }, - "WaitTimeBetweenIterationsInSeconds": { - "type": "integer", - "format": "int64", - "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.", - "default": 30, - "minimum": 0, - "maximum": 4294967295 - }, - "ClusterHealthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check." - }, - "Context": { - "$ref": "#/definitions/ChaosContext", - "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run." - }, - "ChaosTargetFilter": { - "$ref": "#/definitions/ChaosTargetFilter", - "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification." - } - } - }, - "ChaosParametersDictionaryItem": { - "type": "object", - "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs." - }, - "Value": { - "$ref": "#/definitions/ChaosParameters", - "description": "Defines all the parameters to configure a Chaos run." - } - } - }, - "ChaosEvent": { - "type": "object", - "discriminator": "Kind", - "description": "Represents an event generated during a Chaos run.", - "properties": { - "Kind": { - "$ref": "#/definitions/ChaosEventKind", - "description": "The kind of Chaos event." - }, - "TimeStampUtc": { - "type": "string", - "description": "The UTC timestamp when this Chaos event was generated.", - "format": "date-time" - } - }, - "required": [ - "Kind", - "TimeStampUtc" - ] - }, - "ChaosEventWrapper": { - "type": "object", - "description": "Wrapper object for Chaos event.", - "properties": { - "ChaosEvent": { - "$ref": "#/definitions/ChaosEvent", - "description": "Represents an event generated during a Chaos run." - } - } - }, - "ChaosEventKind": { - "type": "string", - "description": "The kind of Chaos event.", - "enum": [ - "Invalid", - "Started", - "ExecutingFaults", - "Waiting", - "ValidationFailed", - "TestError", - "Stopped" - ], - "x-ms-enum": { - "name": "ChaosEventKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Started", - "description": "Indicates a Chaos event that gets generated when Chaos is started." - }, - { - "value": "ExecutingFaults", - "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings." - }, - { - "value": "Waiting", - "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish." - }, - { - "value": "ValidationFailed", - "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds." - }, - { - "value": "TestError", - "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted." - }, - { - "value": "Stopped", - "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up." - } - ] - } - }, - "ChaosEventsSegment": { - "type": "object", - "description": "Contains the list of Chaos events and the continuation token to get the next segment.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "History": { - "$ref": "#/definitions/ChaosEventHistory", - "description": "List of Chaos events that meet the user-supplied criteria." - } - } - }, - "ChaosScheduleDescription": { - "type": "object", - "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.", - "properties": { - "Version": { - "description": "The version number of the Schedule.", - "type": "integer", - "format": "int32", - "minimum": 0 - }, - "Schedule": { - "$ref": "#/definitions/ChaosSchedule", - "description": "Defines the schedule used by Chaos." - } - } - }, - "ChaosSchedule": { - "type": "object", - "description": "Defines the schedule used by Chaos.", - "properties": { - "StartDate": { - "type": "string", - "format": "date-time", - "description": "The date and time Chaos will start using this schedule.", - "default": "1601-01-01T00:00:00Z" - }, - "ExpiryDate": { - "type": "string", - "format": "date-time", - "description": "The date and time Chaos will continue to use this schedule until.", - "default": "9999-12-31T23:59:59.999Z" - }, - "ChaosParametersDictionary": { - "type": "array", - "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.", - "items": { - "$ref": "#/definitions/ChaosParametersDictionaryItem" - } - }, - "Jobs": { - "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.", - "type": "array", - "items": { - "$ref": "#/definitions/ChaosScheduleJob" - } - } - } - }, - "ChaosScheduleJob": { - "type": "object", - "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.", - "properties": { - "ChaosParameters": { - "type": "string", - "description": "A reference to which Chaos Parameters of the Chaos Schedule to use." - }, - "Days": { - "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek", - "description": "Defines the days of the week that a Chaos Schedule Job will run for." - }, - "Times": { - "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.", - "type": "array", - "items": { - "$ref": "#/definitions/TimeRange" - } - } - } - }, - "ChaosScheduleJobActiveDaysOfWeek": { - "type": "object", - "description": "Defines the days of the week that a Chaos Schedule Job will run for.", - "properties": { - "Sunday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Sunday", - "default": false - }, - "Monday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Monday", - "default": false - }, - "Tuesday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Tuesday", - "default": false - }, - "Wednesday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Wednesday", - "default": false - }, - "Thursday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Thursday", - "default": false - }, - "Friday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Friday", - "default": false - }, - "Saturday": { - "type": "boolean", - "description": "Indicates if the Chaos Schedule Job will run on Saturday", - "default": false - } - } - }, - "TimeRange": { - "type": "object", - "description": "Defines a time range in a 24 hour day specified by a start and end time.", - "properties": { - "StartTime": { - "$ref": "#/definitions/TimeOfDay", - "description": "Defines an hour and minute of the day specified in 24 hour time." - }, - "EndTime": { - "$ref": "#/definitions/TimeOfDay", - "description": "Defines an hour and minute of the day specified in 24 hour time." - } - } - }, - "TimeOfDay": { - "type": "object", - "description": "Defines an hour and minute of the day specified in 24 hour time.", - "properties": { - "Hour": { - "type": "integer", - "format": "int32", - "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.", - "minimum": 0, - "maximum": 23 - }, - "Minute": { - "type": "integer", - "format": "int32", - "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.", - "minimum": 0, - "maximum": 59 - } - } - }, - "ExecutingFaultsChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.", - "x-ms-discriminator-value": "ExecutingFaults", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "ExecutingFaultsChaosEvent", - "properties": { - "Faults": { - "type": "array", - "description": "List of string description of the faults that Chaos decided to execute in an iteration.", - "items": { - "type": "string" - } - } - } - } - ] - }, - "StartedChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos is started.", - "x-ms-discriminator-value": "Started", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "StartedChaosEvent", - "properties": { - "ChaosParameters": { - "$ref": "#/definitions/ChaosParameters", - "description": "Defines all the parameters to configure a Chaos run." - } - } - } - ] - }, - "StoppedChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.", - "x-ms-discriminator-value": "Stopped", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "StoppedChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over." - } - } - } - ] - }, - "TestErrorChaosEvent": { - "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.", - "x-ms-discriminator-value": "TestError", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "TestErrorChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant." - } - } - } - ] - }, - "ValidationFailedChaosEvent": { - "description": "Chaos event corresponding to a failure during validation.", - "x-ms-discriminator-value": "ValidationFailed", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "ValidationFailedChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string." - } - } - } - ] - }, - "WaitingChaosEvent": { - "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.", - "x-ms-discriminator-value": "Waiting", - "allOf": [ - { - "$ref": "#/definitions/ChaosEvent" - }, - { - "type": "object", - "description": "WaitingChaosEvent", - "properties": { - "Reason": { - "type": "string", - "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade." - } - } - } - ] - }, - "ChaosEventHistory": { - "type": "array", - "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.", - "items": { - "$ref": "#/definitions/ChaosEventWrapper" - } - }, - "ChaosTargetFilter": { - "type": "object", - "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.", - "properties": { - "NodeTypeInclusionList": { - "type": "array", - "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", - "items": { - "$ref": "#/definitions/NodeType" - } - }, - "ApplicationInclusionList": { - "type": "array", - "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", - "items": { - "$ref": "#/definitions/ApplicationName" - } - } - } - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "The version of the application type as defined in the application manifest." - }, - "ApplicationCapacityDescription": { - "type": "object", - "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application", - "properties": { - "MinimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", - "minimum": 0 - }, - "MaximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", - "minimum": 0, - "default": 0 - }, - "ApplicationMetrics": { - "$ref": "#/definitions/ApplicationMetricDescriptionList", - "description": "List of application capacity metric description." - } - } - }, - "ApplicationDescription": { - "type": "object", - "description": "Describes a Service Fabric application.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "TypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "TypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "ParameterList": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "ApplicationCapacity": { - "$ref": "#/definitions/ApplicationCapacityDescription", - "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application" - } - }, - "required": [ - "Name", - "TypeName", - "TypeVersion" - ] - }, - "ApplicationMetricDescription": { - "type": "object", - "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "MaximumCapacity": { - "type": "integer", - "format": "int64", - "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity." - }, - "ReservationCapacity": { - "type": "integer", - "format": "int64", - "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric." - }, - "TotalApplicationCapacity": { - "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.", - "type": "integer", - "format": "int64" - } - } - }, - "ApplicationMetricDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationMetricDescription" - }, - "description": "List of application capacity metric description." - }, - "ComposeDeploymentStatus": { - "type": "string", - "description": "The status of the compose deployment.", - "enum": [ - "Invalid", - "Provisioning", - "Creating", - "Ready", - "Unprovisioning", - "Deleting", - "Failed", - "Upgrading" - ], - "x-ms-enum": { - "name": "ComposeDeploymentStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the compose deployment status is invalid. The value is zero." - }, - { - "value": "Provisioning", - "description": "Indicates that the compose deployment is being provisioned in background. The value is 1." - }, - { - "value": "Creating", - "description": "Indicates that the compose deployment is being created in background. The value is 2." - }, - { - "value": "Ready", - "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3." - }, - { - "value": "Unprovisioning", - "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4." - }, - { - "value": "Deleting", - "description": "Indicates that the compose deployment is being deleted in background. The value is 5." - }, - { - "value": "Failed", - "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6." - }, - { - "value": "Upgrading", - "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7." - } - ] - } - }, - "ComposeDeploymentStatusInfo": { - "type": "object", - "description": "Information about a Service Fabric compose deployment.", - "properties": { - "Name": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "Status": { - "$ref": "#/definitions/ComposeDeploymentStatus", - "description": "The status of the compose deployment." - }, - "StatusDetails": { - "description": "The status details of compose deployment including failure message.", - "type": "string" - } - } - }, - "ComposeDeploymentUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for a compose deployment upgrade.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ComposeFileContent": { - "type": "string", - "description": "The content of the compose file that describes the deployment to create." - }, - "RegistryCredential": { - "$ref": "#/definitions/RegistryCredential", - "description": "Credential information to connect to container registry." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - } - }, - "required": [ - "DeploymentName", - "ComposeFileContent", - "UpgradeKind" - ] - }, - "ComposeDeploymentUpgradeProgressInfo": { - "type": "object", - "description": "Describes the parameters for a compose deployment upgrade.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/TargetDeploymentName", - "description": "The name of the target deployment." - }, - "ApplicationName": { - "$ref": "#/definitions/TargetApplicationName", - "description": "The name of the target application, including the 'fabric:' URI scheme." - }, - "UpgradeState": { - "$ref": "#/definitions/ComposeDeploymentUpgradeState", - "description": "The state of the compose deployment upgrade." - }, - "UpgradeStatusDetails": { - "type": "string", - "description": "Additional detailed information about the status of the pending upgrade." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicyDescription", - "description": "Describes the parameters for monitoring an upgrade in Monitored mode." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - }, - "TargetApplicationTypeVersion": { - "$ref": "#/definitions/TargetApplicationTypeVersion", - "description": "The target application type version (found in the application manifest) for the application upgrade." - }, - "UpgradeDuration": { - "$ref": "#/definitions/UpgradeDuration", - "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "CurrentUpgradeDomainDuration": { - "$ref": "#/definitions/CurrentUpgradeDomainDuration", - "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "ApplicationUnhealthyEvaluations": { - "$ref": "#/definitions/ApplicationUnhealthyEvaluations", - "description": "List of health evaluations that resulted in the current aggregated health state." - }, - "CurrentUpgradeDomainProgress": { - "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", - "description": "Information about the current in-progress upgrade domain." - }, - "StartTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade started." - }, - "FailureTimestampUtc": { - "type": "string", - "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." - }, - "FailureReason": { - "$ref": "#/definitions/FailureReason", - "description": "The cause of an upgrade failure that resulted in FailureAction being executed." - }, - "UpgradeDomainProgressAtFailure": { - "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", - "description": "Information about the upgrade domain progress at the time of upgrade failure." - }, - "ApplicationUpgradeStatusDetails": { - "type": "string", - "description": "Additional details of application upgrade including failure message." - } - } - }, - "ComposeDeploymentUpgradeState": { - "type": "string", - "description": "The state of the compose deployment upgrade.", - "enum": [ - "Invalid", - "ProvisioningTarget", - "RollingForwardInProgress", - "RollingForwardPending", - "UnprovisioningCurrent", - "RollingForwardCompleted", - "RollingBackInProgress", - "UnprovisioningTarget", - "RollingBackCompleted", - "Failed" - ], - "x-ms-enum": { - "name": "ComposeDeploymentUpgradeState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "ProvisioningTarget", - "description": "The upgrade is in the progress of provisioning target application type version. The value is 1." - }, - { - "value": "RollingForwardInProgress", - "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2." - }, - { - "value": "RollingForwardPending", - "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" - }, - { - "value": "UnprovisioningCurrent", - "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4." - }, - { - "value": "RollingForwardCompleted", - "description": "The upgrade has finished rolling forward. The value is 5." - }, - { - "value": "RollingBackInProgress", - "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6." - }, - { - "value": "UnprovisioningTarget", - "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7." - }, - { - "value": "RollingBackCompleted", - "description": "The upgrade has finished rolling back. The value is 8." - }, - { - "value": "Failed", - "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9." - } - ] - } - }, - "PagedComposeDeploymentStatusInfoList": { - "type": "object", - "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of compose deployment status information.", - "items": { - "$ref": "#/definitions/ComposeDeploymentStatusInfo" - } - } - } - }, - "CreateComposeDeploymentDescription": { - "type": "object", - "description": "Defines description for creating a Service Fabric compose deployment.", - "properties": { - "DeploymentName": { - "$ref": "#/definitions/DeploymentName", - "description": "The name of the deployment." - }, - "ComposeFileContent": { - "type": "string", - "description": "The content of the compose file that describes the deployment to create." - }, - "RegistryCredential": { - "$ref": "#/definitions/RegistryCredential", - "description": "Credential information to connect to container registry." - } - }, - "required": [ - "DeploymentName", - "ComposeFileContent" - ] - }, - "RegistryCredential": { - "type": "object", - "description": "Credential information to connect to container registry.", - "properties": { - "RegistryUserName": { - "type": "string", - "description": "The user name to connect to container registry." - }, - "RegistryPassword": { - "type": "string", - "description": "The password for supplied username to connect to container registry." - }, - "PasswordEncrypted": { - "type": "boolean", - "description": "Indicates that supplied container registry password is encrypted." - } - } - }, - "DeployedServicePackageInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackageInfo" - }, - "description": "List of deployed service package information." - }, - "DeployedServicePackageInfo": { - "type": "object", - "description": "Information about service package deployed on a Service Fabric node.", - "properties": { - "Name": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service package as specified in the service manifest." - }, - "Version": { - "type": "string", - "description": "The version of the service package specified in service manifest." - }, - "Status": { - "$ref": "#/definitions/DeploymentStatus", - "description": "Specifies the status of a deployed application or service package on a Service Fabric node." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - }, - "DeploymentName": { - "type": "string", - "description": "The name of the deployment." - }, - "CorrelationSchemeList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "MoveCost": { - "type": "string", - "description": "Specifies the move cost for the service.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "MoveCost", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Zero move cost. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the move cost of the service as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the move cost of the service as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the move cost of the service as High. The value is 3." - } - ] - } - }, - "PartitionScheme": { - "type": "string", - "description": "Enumerates the ways that a service can be partitioned.", - "enum": [ - "Invalid", - "Singleton", - "UniformInt64Range", - "Named" - ], - "x-ms-enum": { - "name": "PartitionScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Singleton", - "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." - }, - { - "value": "UniformInt64Range", - "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." - }, - { - "value": "Named", - "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" - } - ] - } - }, - "ServiceCorrelationDescription": { - "type": "object", - "description": "Creates a particular correlation between services.", - "required": [ - "Scheme", - "ServiceName" - ], - "properties": { - "Scheme": { - "$ref": "#/definitions/ServiceCorrelationScheme", - "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service that the correlation relationship is established with." - } - } - }, - "ServiceCorrelationScheme": { - "type": "string", - "description": "The service correlation scheme.", - "enum": [ - "Invalid", - "Affinity", - "AlignedAffinity", - "NonAlignedAffinity" - ], - "x-ms-enum": { - "name": "ServiceCorrelationScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "An invalid correlation scheme. Cannot be used. The value is zero." - }, - { - "value": "Affinity", - "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." - }, - { - "value": "AlignedAffinity", - "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." - }, - { - "value": "NonAlignedAffinity", - "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." - } - ] - } - }, - "ServiceLoadMetricsList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceLoadMetricDescription" - }, - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServiceLoadMetricDescription": { - "type": "object", - "description": "Specifies a metric to load balance a service during runtime.", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive." - }, - "Weight": { - "$ref": "#/definitions/ServiceLoadMetricWeight", - "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." - }, - "PrimaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." - }, - "SecondaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." - }, - "DefaultLoad": { - "type": "integer", - "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." - } - } - }, - "ServiceLoadMetricWeight": { - "type": "string", - "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "ServiceLoadMetricWeight", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Disables resource balancing for this metric. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the metric weight of the service load as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the metric weight of the service load as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the metric weight of the service load as High. The value is 3." - } - ] - } - }, - "ServicePackageActivationMode": { - "type": "string", - "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.", - "enum": [ - "SharedProcess", - "ExclusiveProcess" - ], - "x-ms-enum": { - "name": "ServicePackageActivationMode", - "modelAsString": true, - "values": [ - { - "value": "SharedProcess", - "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero." - }, - { - "value": "ExclusiveProcess", - "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1." - } - ] - } - }, - "ServicePlacementPoliciesList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "PartitionSchemeDescription": { - "type": "object", - "discriminator": "PartitionScheme", - "description": "Describes how the service is partitioned.", - "required": [ - "PartitionScheme" - ], - "properties": { - "PartitionScheme": { - "$ref": "#/definitions/PartitionScheme", - "description": "Specifies how the service is partitioned." - } - } - }, - "NamedPartitionSchemeDescription": { - "description": "Describes the named partition scheme of the service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "NamedPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Named", - "required": [ - "Count", - "Names" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "Names": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." - } - } - }, - "SingletonPartitionSchemeDescription": { - "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "SingletonPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "UniformInt64RangePartitionSchemeDescription": { - "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "UniformInt64RangePartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "UniformInt64Range", - "required": [ - "Count", - "LowKey", - "HighKey" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "LowKey": { - "type": "string", - "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions." - }, - "HighKey": { - "type": "string", - "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions." - } - } - }, - "ServiceDescription": { - "type": "object", - "discriminator": "ServiceKind", - "description": "A ServiceDescription contains all of the information necessary to create a service.", - "required": [ - "ServiceKind", - "ServiceName", - "ServiceTypeName", - "PartitionDescription" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The service kind." - }, - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "InitializationData": { - "$ref": "#/definitions/ByteArray", - "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created." - }, - "PartitionDescription": { - "$ref": "#/definitions/PartitionSchemeDescription", - "description": "The partition description as an object." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "CorrelationScheme": { - "$ref": "#/definitions/CorrelationSchemeList", - "description": "The correlation scheme." - }, - "ServiceLoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList", - "description": "The service placement policies." - }, - "DefaultMoveCost": { - "$ref": "#/definitions/MoveCost", - "description": "The move cost for the service." - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean", - "description": "Indicates if the DefaultMoveCost property is specified." - }, - "ServicePackageActivationMode": { - "$ref": "#/definitions/ServicePackageActivationMode", - "description": "The activation mode of service package to be used for a service." - }, - "ServiceDnsName": { - "type": "string", - "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." - }, - "ScalingPolicies": { - "$ref": "#/definitions/ScalingPolicyDescriptionList", - "description": "Scaling policies for this service." - } - } - }, - "StatefulServiceDescription": { - "description": "Describes a stateful service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - }, - { - "type": "object", - "description": "StatefulServiceDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "required": [ - "TargetReplicaSetSize", - "MinReplicaSetSize", - "HasPersistedState" - ], - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "HasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - }, - "Flags": { - "type": "integer", - "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4." - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The definition on how long StandBy replicas should be maintained before being removed." - } - } - }, - "StatelessServiceDescription": { - "description": "Describes a stateless service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - }, - { - "type": "object", - "description": "StatelessServiceDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "required": [ - "InstanceCount" - ], - "properties": { - "InstanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "ReplicatorQueueStatus": { - "type": "object", - "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.", - "properties": { - "QueueUtilizationPercentage": { - "type": "integer", - "format": "int32", - "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full." - }, - "QueueMemorySize": { - "type": "string", - "description": "Represents the virtual memory consumed by the queue in bytes." - }, - "FirstSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue." - }, - "CompletedSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state." - }, - "CommittedSequenceNumber": { - "type": "string", - "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary." - }, - "LastSequenceNumber": { - "type": "string", - "description": "Represents the latest sequence number of the operation that is available in the queue." - } - } - }, - "ReplicatorStatus": { - "type": "object", - "discriminator": "Kind", - "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ReplicaRole", - "description": "The role of a replica of a stateful service." - } - } - }, - "PrimaryReplicatorStatus": { - "x-ms-discriminator-value": "Primary", - "type": "object", - "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", - "allOf": [ - { - "$ref": "#/definitions/ReplicatorStatus" - }, - { - "type": "object", - "description": "Status of the primary replicator.", - "properties": { - "ReplicationQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the replication queue on the primary replicator." - }, - "RemoteReplicators": { - "$ref": "#/definitions/RemoteReplicatorStatusList", - "description": "The status of all the active and idle secondary replicators that the primary is aware of." - } - } - } - ] - }, - "SecondaryReplicatorStatus": { - "type": "object", - "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", - "allOf": [ - { - "$ref": "#/definitions/ReplicatorStatus" - }, - { - "type": "object", - "description": "Represents a base class for secondary replicator status.", - "properties": { - "ReplicationQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the replication queue on the secondary replicator." - }, - "LastReplicationOperationReceivedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received." - }, - "IsInBuild": { - "type": "boolean", - "description": "Value that indicates whether the replica is currently being built." - }, - "CopyQueueStatus": { - "$ref": "#/definitions/ReplicatorQueueStatus", - "description": "Details about the copy queue on the secondary replicator." - }, - "LastCopyOperationReceivedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received." - }, - "LastAcknowledgementSentTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent." - } - } - } - ] - }, - "SecondaryActiveReplicatorStatus": { - "x-ms-discriminator-value": "ActiveSecondary", - "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.", - "allOf": [ - { - "$ref": "#/definitions/SecondaryReplicatorStatus" - }, - { - "type": "object" - } - ] - }, - "SecondaryIdleReplicatorStatus": { - "x-ms-discriminator-value": "IdleSecondary", - "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.", - "allOf": [ - { - "$ref": "#/definitions/SecondaryReplicatorStatus" - }, - { - "type": "object" - } - ] - }, - "RemoteReplicatorStatus": { - "type": "object", - "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Represents the replica ID of the remote secondary replicator." - }, - "LastAcknowledgementProcessedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed." - }, - "LastReceivedReplicationSequenceNumber": { - "type": "string", - "description": "The highest replication operation sequence number that the secondary has received from the primary." - }, - "LastAppliedReplicationSequenceNumber": { - "type": "string", - "description": "The highest replication operation sequence number that the secondary has applied to its state." - }, - "IsInBuild": { - "type": "boolean", - "description": "A value that indicates whether the secondary replica is in the process of being built." - }, - "LastReceivedCopySequenceNumber": { - "type": "string", - "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations." - }, - "LastAppliedCopySequenceNumber": { - "type": "string", - "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete." - }, - "RemoteReplicatorAcknowledgementStatus": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus", - "description": "Represents the acknowledgment status for the remote secondary replicator." - } - } - }, - "RemoteReplicatorStatusList": { - "type": "array", - "items": { - "$ref": "#/definitions/RemoteReplicatorStatus" - }, - "description": "List of remote replicator status" - }, - "RemoteReplicatorAcknowledgementStatus": { - "type": "object", - "description": "Provides details about the remote replicators from the primary replicator's point of view.", - "properties": { - "ReplicationStreamAcknowledgementDetail": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", - "description": "Details about the acknowledgements for operations that are part of the replication stream data." - }, - "CopyStreamAcknowledgementDetail": { - "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", - "description": "Details about the acknowledgements for operations that are part of the copy stream data." - } - } - }, - "RemoteReplicatorAcknowledgementDetail": { - "type": "object", - "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.", - "properties": { - "AverageReceiveDuration": { - "type": "string", - "description": "Represents the average duration it takes for the remote replicator to receive an operation." - }, - "AverageApplyDuration": { - "type": "string", - "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk." - }, - "NotReceivedCount": { - "type": "string", - "description": "Represents the number of operations not yet received by a remote replicator." - }, - "ReceivedAndNotAppliedCount": { - "type": "string", - "description": "Represents the number of operations received and not yet applied by a remote replicator." - } - } - }, - "DeployedServiceReplicaDetailInfo": { - "type": "object", - "discriminator": "ServiceKind", - "description": "Information about a Service Fabric service replica deployed on a node.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "Full hierarchical name of the service in URI format starting with `fabric:`." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - }, - "CurrentServiceOperation": { - "$ref": "#/definitions/ServiceOperationName", - "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance." - }, - "CurrentServiceOperationStartTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The start time of the current service operation in UTC format." - }, - "ReportedLoad": { - "$ref": "#/definitions/LoadMetricReportInfoList", - "description": "List of load reported by replica." - } - } - }, - "DeployedStatefulServiceReplicaDetailInfo": { - "description": "Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", - "x-ms-discriminator-value": "Stateful", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - }, - { - "type": "object", - "description": "DeployedStatefulServiceReplicaDetailInfo", - "properties": { - "ReplicaId": { - "$ref": "#/definitions/ReplicaId", - "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." - }, - "CurrentReplicatorOperation": { - "$ref": "#/definitions/ReplicatorOperationName", - "description": "Specifies the operation currently being executed by the Replicator." - }, - "ReadStatus": { - "$ref": "#/definitions/PartitionAccessStatus", - "description": "Specifies the access status of the partition." - }, - "WriteStatus": { - "$ref": "#/definitions/PartitionAccessStatus", - "description": "Specifies the access status of the partition." - }, - "ReplicatorStatus": { - "$ref": "#/definitions/ReplicatorStatus", - "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc." - }, - "ReplicaStatus": { - "$ref": "#/definitions/KeyValueStoreReplicaStatus", - "description": "Key value store related information for the replica." - }, - "DeployedServiceReplicaQueryResult": { - "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo", - "description": "Information about a stateful service replica deployed on a node." - } - } - } - ] - }, - "DeployedStatelessServiceInstanceDetailInfo": { - "description": "Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", - "x-ms-discriminator-value": "Stateless", - "allOf": [ - { - "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" - }, - { - "type": "object", - "description": "DeployedStatelessServiceInstanceDetailInfo", - "properties": { - "InstanceId": { - "$ref": "#/definitions/InstanceId", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - }, - "DeployedServiceReplicaQueryResult": { - "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo", - "description": "Information about a stateless service instance deployed on a node." - } - } - } - ] - }, - "FabricReplicaStatus": { - "type": "string", - "description": "Specifies the status of the replica.", - "enum": [ - "Invalid", - "Down", - "Up" - ], - "x-ms-enum": { - "name": "FabricReplicaStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." - }, - { - "value": "Down", - "description": "Indicates that the replica is down." - }, - { - "value": "Up", - "description": "Indicates that the replica is up." - } - ] - } - }, - "LoadMetricReportInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/LoadMetricReportInfo" - }, - "description": "List of load reported by replica." - }, - "LoadMetricReportInfo": { - "type": "object", - "description": "Information about load reported by replica.", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "Value": { - "type": "integer", - "format": "int32", - "description": "The value of the load for the metric.." - }, - "LastReportedUtc": { - "type": "string", - "format": "date-time", - "description": "The UTC time when the load is reported." - } - } - }, - "PartitionAccessStatus": { - "type": "string", - "description": "Specifies the access status of the partition.", - "enum": [ - "Invalid", - "Granted", - "ReconfigurationPending", - "NotPrimary", - "NoWriteQuorum" - ], - "x-ms-enum": { - "name": "PartitionAccessStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." - }, - { - "value": "Granted", - "description": "Indicates that the read or write operation access is granted and the operation is allowed." - }, - { - "value": "ReconfigurationPending", - "description": "Indicates that the client should try again later, because a reconfiguration is in progress." - }, - { - "value": "NotPrimary", - "description": "Indicates that this client request was received by a replica that is not a Primary replica." - }, - { - "value": "NoWriteQuorum", - "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted." - } - ] - } - }, - "ReplicatorOperationName": { - "type": "string", - "description": "Specifies the operation currently being executed by the Replicator.", - "enum": [ - "Invalid", - "None", - "Open", - "ChangeRole", - "UpdateEpoch", - "Close", - "Abort", - "OnDataLoss", - "WaitForCatchup", - "Build" - ], - "x-ms-enum": { - "name": "ReplicatorOperationName", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Default value if the replicator is not yet ready." - }, - { - "value": "None", - "description": "Replicator is not running any operation from Service Fabric perspective." - }, - { - "value": "Open", - "description": "Replicator is opening." - }, - { - "value": "ChangeRole", - "description": "Replicator is in the process of changing its role." - }, - { - "value": "UpdateEpoch", - "description": "Due to a change in the replica set, replicator is being updated with its Epoch." - }, - { - "value": "Close", - "description": "Replicator is closing." - }, - { - "value": "Abort", - "description": "Replicator is being aborted." - }, - { - "value": "OnDataLoss", - "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source." - }, - { - "value": "WaitForCatchup", - "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state." - }, - { - "value": "Build", - "description": "Replicator is in the process of building one or more replicas." - } - ] - } - }, - "ServiceOperationName": { - "type": "string", - "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.", - "enum": [ - "Unknown", - "None", - "Open", - "ChangeRole", - "Close", - "Abort" - ], - "x-ms-enum": { - "name": "ServiceOperationName", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Reserved for future use." - }, - { - "value": "None", - "description": "The service replica or instance is not going through any life-cycle changes." - }, - { - "value": "Open", - "description": "The service replica or instance is being opened." - }, - { - "value": "ChangeRole", - "description": "The service replica is changing roles." - }, - { - "value": "Close", - "description": "The service replica or instance is being closed." - }, - { - "value": "Abort", - "description": "The service replica or instance is being aborted." - } - ] - } - }, - "ReplicaKind": { - "type": "string", - "description": "The role of a replica of a stateful service.", - "enum": [ - "Invalid", - "KeyValueStore" - ], - "x-ms-enum": { - "name": "ReplicaKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Represents an invalid replica kind. The value is zero." - }, - { - "value": "KeyValueStore", - "description": "Represents a key value store replica. The value is 1" - } - ] - } - }, - "ReplicaStatusBase": { - "type": "object", - "discriminator": "Kind", - "description": "Information about the replica.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ReplicaKind", - "description": "The role of a replica of a stateful service." - } - } - }, - "KeyValueStoreReplicaStatus": { - "description": "Key value store related information for the replica.", - "x-ms-discriminator-value": "KeyValueStore", - "allOf": [ - { - "$ref": "#/definitions/ReplicaStatusBase" - }, - { - "type": "object", - "description": "KeyValueStoreReplicaStatus", - "properties": { - "DatabaseRowCountEstimate": { - "type": "string", - "description": "Value indicating the estimated number of rows in the underlying database." - }, - "DatabaseLogicalSizeEstimate": { - "type": "string", - "description": "Value indicating the estimated size of the underlying database." - }, - "CopyNotificationCurrentKeyFilter": { - "type": "string", - "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback." - }, - "CopyNotificationCurrentProgress": { - "type": "string", - "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback." - }, - "StatusDetails": { - "type": "string", - "description": "Value indicating the current status details of the replica." - } - } - } - ] - }, - "ServiceUpdateDescription": { - "type": "object", - "discriminator": "ServiceKind", - "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The service kind." - }, - "Flags": { - "type": "string", - "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024." - }, - "PlacementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "CorrelationScheme": { - "$ref": "#/definitions/CorrelationSchemeList", - "description": "The correlation scheme." - }, - "LoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics." - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList", - "description": "The service placement policies." - }, - "DefaultMoveCost": { - "$ref": "#/definitions/MoveCost", - "description": "The move cost for the service." - }, - "ScalingPolicies": { - "$ref": "#/definitions/ScalingPolicyDescriptionList", - "description": "Scaling policies for this service." - } - } - }, - "StatefulServiceUpdateDescription": { - "description": "Describes an update for a stateful service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - }, - { - "type": "object", - "description": "StatefulServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "TargetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "MinReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "string", - "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." - }, - "QuorumLossWaitDurationSeconds": { - "type": "string", - "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." - }, - "StandByReplicaKeepDurationSeconds": { - "type": "string", - "description": "The definition on how long StandBy replicas should be maintained before being removed." - } - } - }, - "StatelessServiceUpdateDescription": { - "description": "Describes an update for a stateless service.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - }, - { - "type": "object", - "description": "StatelessServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "InstanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "ImageStoreRelativePath": { - "type": "string", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "FileVersion": { - "type": "object", - "description": "Information about the version of image store file.", - "properties": { - "VersionNumber": { - "type": "string", - "description": "The current image store version number for the file is used in image store for checking whether it need to be updated." - }, - "EpochDataLossNumber": { - "type": "string", - "description": "The epoch data loss number of image store replica when this file entry was updated or created." - }, - "EpochConfigurationNumber": { - "type": "string", - "description": "The epoch configuration version number of the image store replica when this file entry was created or updated." - } - } - }, - "FileInfo": { - "type": "object", - "description": "Information about a image store file.", - "properties": { - "FileSize": { - "type": "string", - "description": "The size of file in bytes." - }, - "FileVersion": { - "$ref": "#/definitions/FileVersion", - "description": "Information about the version of image store file." - }, - "ModifiedDate": { - "type": "string", - "format": "date-time", - "description": "The date and time when the image store file was last modified." - }, - "StoreRelativePath": { - "type": "string", - "description": "The file path relative to the image store root path." - } - } - }, - "FolderInfo": { - "type": "object", - "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.", - "properties": { - "StoreRelativePath": { - "$ref": "#/definitions/ImageStoreRelativePath", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "FileCount": { - "type": "string", - "description": "The number of files from within the image store folder." - } - } - }, - "ImageStoreContent": { - "type": "object", - "description": "Information about the image store content.", - "properties": { - "StoreFiles": { - "type": "array", - "items": { - "$ref": "#/definitions/FileInfo" - }, - "description": "The list of image store file info objects represents files found under the given image store relative path." - }, - "StoreFolders": { - "type": "array", - "items": { - "$ref": "#/definitions/FolderInfo" - }, - "description": "The list of image store folder info objects represents subfolders found under the given image store relative path." - } - } - }, - "ImageStoreCopyDescription": { - "type": "object", - "description": "Information about how to copy image store content from one image store relative path to another image store relative path.", - "required": [ - "RemoteSource", - "RemoteDestination" - ], - "properties": { - "RemoteSource": { - "type": "string", - "description": "The relative path of source image store content to be copied from." - }, - "RemoteDestination": { - "type": "string", - "description": "The relative path of destination image store content to be copied to." - }, - "SkipFiles": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of the file names to be skipped for copying." - }, - "CheckMarkFile": { - "type": "boolean", - "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped." - } - } - }, - "InstanceId": { - "type": "string", - "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." - }, - "CodePackageInstanceId": { - "type": "string", - "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." - }, - "HostIsolationMode": { - "type": "string", - "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.", - "enum": [ - "None", - "Process", - "HyperV" - ], - "x-ms-enum": { - "name": "HostIsolationMode", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0." - }, - { - "value": "Process", - "description": "This is the default isolation mode for a ContainerHost. The value is 1." - }, - { - "value": "HyperV", - "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2." - } - ] - } - }, - "HostType": { - "type": "string", - "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.", - "enum": [ - "Invalid", - "ExeHost", - "ContainerHost" - ], - "x-ms-enum": { - "name": "HostType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the type of host is not known or invalid. The value is 0." - }, - { - "value": "ExeHost", - "description": "Indicates the host is an executable. The value is 1." - }, - { - "value": "ContainerHost", - "description": "Indicates the host is a container. The value is 2." - } - ] - } - }, - "RestartDeployedCodePackageDescription": { - "type": "object", - "description": "Defines description for restarting a deployed code package on Service Fabric node.", - "required": [ - "ServiceManifestName", - "CodePackageName", - "CodePackageInstanceId" - ], - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest that specified this code package." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package defined in the service manifest." - }, - "CodePackageInstanceId": { - "$ref": "#/definitions/CodePackageInstanceId", - "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package." - } - } - }, - "DeployedServiceTypeInfo": { - "type": "object", - "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.", - "properties": { - "ServiceTypeName": { - "$ref": "#/definitions/ServiceTypeName", - "description": "Name of the service type as specified in the service manifest." - }, - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of the service manifest in which this service type is defined." - }, - "CodePackageName": { - "$ref": "#/definitions/CodePackageName", - "description": "The name of the code package that registered the service type." - }, - "Status": { - "$ref": "#/definitions/ServiceTypeRegistrationStatus", - "description": "The status of the service type registration on the node." - }, - "ServicePackageActivationId": { - "$ref": "#/definitions/ServicePackageActivationId", - "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." - } - } - }, - "DeployedServiceTypeInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServiceTypeInfo" - }, - "description": "List of information about service type deployed on a node." - }, - "ServiceTypeRegistrationStatus": { - "type": "string", - "description": "The status of the service type registration on the node.", - "enum": [ - "Invalid", - "Disabled", - "Enabled", - "Registered" - ], - "x-ms-enum": { - "name": "ServiceTypeRegistrationStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Disabled", - "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1." - }, - { - "value": "Enabled", - "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2." - }, - { - "value": "Registered", - "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3." - } - ] - } - }, - "ServiceEndpointRole": { - "type": "string", - "description": "The role of the replica where the endpoint is reported.", - "enum": [ - "Invalid", - "Stateless", - "StatefulPrimary", - "StatefulSecondary" - ], - "x-ms-enum": { - "name": "ServiceEndpointRole", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Stateless", - "description": "Indicates that the service endpoint is of a stateless service. The value is 1." - }, - { - "value": "StatefulPrimary", - "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2." - }, - { - "value": "StatefulSecondary", - "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3." - } - ] - } - }, - "ResolvedServiceEndpoint": { - "type": "object", - "description": "Endpoint of a resolved service partition.", - "properties": { - "Kind": { - "$ref": "#/definitions/ServiceEndpointRole", - "description": "The role of the replica where the endpoint is reported." - }, - "Address": { - "type": "string", - "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener." - } - } - }, - "ResolvedServicePartition": { - "type": "object", - "description": "Information about a service partition and its associated endpoints.", - "required": [ - "Name", - "PartitionInformation", - "Endpoints", - "Version" - ], - "properties": { - "Name": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "A representation of the resolved partition." - }, - "Endpoints": { - "$ref": "#/definitions/ResolvedServiceEndpointList", - "description": "List of resolved service endpoints of a service partition." - }, - "Version": { - "type": "string", - "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter." - } - } - }, - "ResolvedServiceEndpointList": { - "type": "array", - "items": { - "$ref": "#/definitions/ResolvedServiceEndpoint" - }, - "description": "List of resolved service endpoints of a service partition." - }, - "InvokeDataLossResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "InvokeQuorumLossResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "NodeResult": { - "type": "object", - "description": "Contains information about a node that was targeted by a user-induced operation.", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "NodeInstanceId": { - "type": "string", - "description": "The node instance id." - } - } - }, - "NodeTransitionProgress": { - "type": "object", - "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "NodeTransitionResult": { - "$ref": "#/definitions/NodeTransitionResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "NodeTransitionResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "NodeResult": { - "$ref": "#/definitions/NodeResult", - "description": "Contains information about a node that was targeted by a user-induced operation." - } - } - }, - "OperationId": { - "type": "string", - "format": "uuid", - "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." - }, - "OperationState": { - "type": "string", - "description": "The state of the operation.", - "enum": [ - "Invalid", - "Running", - "RollingBack", - "Completed", - "Faulted", - "Cancelled", - "ForceCancelled" - ], - "x-ms-enum": { - "name": "OperationState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The operation state is invalid." - }, - { - "value": "Running", - "description": "The operation is in progress." - }, - { - "value": "RollingBack", - "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command." - }, - { - "value": "Completed", - "description": "The operation has completed successfully and is no longer running." - }, - { - "value": "Faulted", - "description": "The operation has failed and is no longer running." - }, - { - "value": "Cancelled", - "description": "The operation was cancelled by the user using CancelOperation, and is no longer running." - }, - { - "value": "ForceCancelled", - "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details." - } - ] - } - }, - "OperationStatus": { - "type": "object", - "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.", - "properties": { - "OperationId": { - "$ref": "#/definitions/OperationId", - "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." - }, - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "Type": { - "$ref": "#/definitions/OperationType", - "description": "The type of the operation." - } - } - }, - "OperationStatusList": { - "type": "array", - "description": "A list of OperationStatus objects.", - "items": { - "$ref": "#/definitions/OperationStatus" - } - }, - "OperationType": { - "type": "string", - "description": "The type of the operation.", - "enum": [ - "Invalid", - "PartitionDataLoss", - "PartitionQuorumLoss", - "PartitionRestart", - "NodeTransition" - ], - "x-ms-enum": { - "name": "OperationType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The operation state is invalid." - }, - { - "value": "PartitionDataLoss", - "description": "An operation started using the StartDataLoss API." - }, - { - "value": "PartitionQuorumLoss", - "description": "An operation started using the StartQuorumLoss API." - }, - { - "value": "PartitionRestart", - "description": "An operation started using the StartPartitionRestart API." - }, - { - "value": "NodeTransition", - "description": "An operation started using the StartNodeTransition API." - } - ] - } - }, - "PartitionDataLossProgress": { - "type": "object", - "description": "Information about a partition data loss user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "InvokeDataLossResult": { - "$ref": "#/definitions/InvokeDataLossResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "PartitionQuorumLossProgress": { - "type": "object", - "description": "Information about a partition quorum loss user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "InvokeQuorumLossResult": { - "$ref": "#/definitions/InvokeQuorumLossResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "PartitionRestartProgress": { - "type": "object", - "description": "Information about a partition restart user-induced operation.", - "properties": { - "State": { - "$ref": "#/definitions/OperationState", - "description": "The state of the operation." - }, - "RestartPartitionResult": { - "$ref": "#/definitions/RestartPartitionResult", - "description": "Represents information about an operation in a terminal state (Completed or Faulted)." - } - } - }, - "RestartPartitionResult": { - "type": "object", - "description": "Represents information about an operation in a terminal state (Completed or Faulted).", - "properties": { - "ErrorCode": { - "type": "integer", - "format": "int32", - "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." - }, - "SelectedPartition": { - "$ref": "#/definitions/SelectedPartition", - "description": "This class returns information about the partition that the user-induced operation acted upon." - } - } - }, - "SelectedPartition": { - "type": "object", - "description": "This class returns information about the partition that the user-induced operation acted upon.", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service the partition belongs to." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - }, - "DeployServicePackageToNodeDescription": { - "type": "object", - "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.", - "properties": { - "ServiceManifestName": { - "$ref": "#/definitions/ServiceManifestName", - "description": "The name of service manifest whose packages need to be downloaded." - }, - "ApplicationTypeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "PackageSharingPolicy": { - "$ref": "#/definitions/PackageSharingPolicyInfoList", - "description": "List of package sharing policy information." - } - }, - "required": [ - "ServiceManifestName", - "ApplicationTypeName", - "ApplicationTypeVersion", - "NodeName" - ] - }, - "PackageSharingPolicyInfo": { - "type": "object", - "description": "Represents a policy for the package sharing.", - "properties": { - "SharedPackageName": { - "type": "string", - "description": "The name of code, configuration or data package that should be shared." - }, - "PackageSharingScope": { - "$ref": "#/definitions/PackageSharingPolicyScope", - "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation." - } - } - }, - "PackageSharingPolicyInfoList": { - "type": "array", - "items": { - "$ref": "#/definitions/PackageSharingPolicyInfo" - }, - "description": "List of package sharing policy information." - }, - "PackageSharingPolicyScope": { - "type": "string", - "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.", - "enum": [ - "None", - "All", - "Code", - "Config", - "Data" - ], - "x-ms-enum": { - "name": "PackageSharingPolicyScope", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "No package sharing policy scope. The value is 0." - }, - { - "value": "All", - "description": "Share all code, config and data packages from corresponding service manifest. The value is 1." - }, - { - "value": "Code", - "description": "Share all code packages from corresponding service manifest. The value is 2." - }, - { - "value": "Config", - "description": "Share all config packages from corresponding service manifest. The value is 3." - }, - { - "value": "Data", - "description": "Share all data packages from corresponding service manifest. The value is 4." - } - ] - } - }, - "ResumeApplicationUpgradeDescription": { - "type": "object", - "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade", - "properties": { - "UpgradeDomainName": { - "type": "string", - "description": "The name of the upgrade domain in which to resume the upgrade." - } - }, - "required": [ - "UpgradeDomainName" - ] - }, - "ApplicationUpgradeUpdateDescription": { - "type": "object", - "description": "Describes the parameters for updating an ongoing application upgrade.", - "properties": { - "Name": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - }, - "UpgradeKind": { - "$ref": "#/definitions/UpgradeKind", - "description": "The kind of upgrade out of the following possible values." - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." - }, - "UpdateDescription": { - "$ref": "#/definitions/RollingUpgradeUpdateDescription", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster." - } - }, - "required": [ - "Name", - "UpgradeKind" - ] - }, - "RollingUpgradeUpdateDescription": { - "type": "object", - "description": "Describes the parameters for updating a rolling upgrade of application or cluster.", - "properties": { - "RollingUpgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." - }, - "ForceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "ReplicaSetCheckTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "FailureAction": { - "$ref": "#/definitions/FailureAction", - "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." - }, - "HealthCheckWaitDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckWaitDuration", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckStableDurationInMilliseconds": { - "$ref": "#/definitions/HealthCheckStableDuration", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "$ref": "#/definitions/HealthCheckRetryTimeout", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeTimeout", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "UpgradeDomainTimeoutInMilliseconds": { - "$ref": "#/definitions/UpgradeDomainTimeout", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - } - }, - "required": [ - "RollingUpgradeMode" - ] - }, - "NameDescription": { - "type": "object", - "description": "Describes a Service Fabric name.", - "properties": { - "Name": { - "$ref": "#/definitions/FabricName", - "description": "The Service Fabric name, including the 'fabric:' URI scheme." - } - }, - "required": [ - "Name" - ] - }, - "FabricName": { - "type": "string", - "description": "The Service Fabric name, including the 'fabric:' URI scheme." - }, - "PagedSubNameInfoList": { - "type": "object", - "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "IsConsistent": { - "type": "boolean", - "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false." - }, - "SubNames": { - "type": "array", - "description": "List of the child names.", - "items": { - "$ref": "#/definitions/FabricName" - } - } - } - }, - "PropertyValueKind": { - "type": "string", - "description": "The kind of property, determined by the type of data. Following are the possible values.", - "enum": [ - "Invalid", - "Binary", - "Int64", - "Double", - "String", - "Guid" - ], - "x-ms-enum": { - "name": "PropertyValueKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Binary", - "description": "The data inside the property is a binary blob. The value is 1." - }, - { - "value": "Int64", - "description": "The data inside the property is an int64. The value is 2." - }, - { - "value": "Double", - "description": "The data inside the property is a double. The value is 3." - }, - { - "value": "String", - "description": "The data inside the property is a string. The value is 4." - }, - { - "value": "Guid", - "description": "The data inside the property is a guid. The value is 5." - } - ] - } - }, - "PropertyValue": { - "type": "object", - "discriminator": "Kind", - "description": "Describes a Service Fabric property value.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyValueKind", - "description": "The kind of property, determined by the type of data. Following are the possible values." - } - }, - "required": [ - "Kind" - ] - }, - "BinaryPropertyValue": { - "description": "Describes a Service Fabric property value of type Binary.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "BinaryPropertyValue" - } - ], - "x-ms-discriminator-value": "Binary", - "required": [ - "Data" - ], - "properties": { - "Data": { - "$ref": "#/definitions/ByteArray", - "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255." - } - } - }, - "Int64PropertyValue": { - "description": "Describes a Service Fabric property value of type Int64.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "Int64PropertyValue" - } - ], - "x-ms-discriminator-value": "Int64", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "description": "The data of the property value." - } - } - }, - "DoublePropertyValue": { - "description": "Describes a Service Fabric property value of type Double.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "DoublePropertyValue" - } - ], - "x-ms-discriminator-value": "Double", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "number", - "format": "double", - "description": "The data of the property value." - } - } - }, - "StringPropertyValue": { - "description": "Describes a Service Fabric property value of type String.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "StringPropertyValue" - } - ], - "x-ms-discriminator-value": "String", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "description": "The data of the property value." - } - } - }, - "GuidPropertyValue": { - "description": "Describes a Service Fabric property value of type Guid.", - "allOf": [ - { - "$ref": "#/definitions/PropertyValue" - }, - { - "type": "object", - "description": "GuidPropertyValue" - } - ], - "x-ms-discriminator-value": "Guid", - "required": [ - "Data" - ], - "properties": { - "Data": { - "type": "string", - "format": "uuid", - "description": "The data of the property value." - } - } - }, - "PropertyInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Information about a Service Fabric property.", - "properties": { - "Name": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - }, - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - }, - "Metadata": { - "$ref": "#/definitions/PropertyMetadata", - "description": "The metadata associated with a property, including the property's name." - } - }, - "required": [ - "Name", - "Metadata" - ] - }, - "PagedPropertyInfoList": { - "type": "object", - "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "IsConsistent": { - "type": "boolean", - "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false." - }, - "Properties": { - "type": "array", - "description": "List of property information.", - "items": { - "$ref": "#/definitions/PropertyInfo" - } - } - } - }, - "PropertyDescription": { - "type": "object", - "description": "Description of a Service Fabric property.", - "properties": { - "PropertyName": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." - }, - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - } - }, - "required": [ - "PropertyName", - "Value" - ] - }, - "PropertyName": { - "type": "string", - "description": "The name of the Service Fabric property." - }, - "PropertyMetadata": { - "type": "object", - "description": "The metadata associated with a property, including the property's name.", - "properties": { - "TypeId": { - "$ref": "#/definitions/PropertyValueKind", - "description": "The kind of property, determined by the type of data. Following are the possible values." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type ID." - }, - "Parent": { - "$ref": "#/definitions/FabricName", - "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists." - }, - "SizeInBytes": { - "type": "integer", - "description": "The length of the serialized property value." - }, - "LastModifiedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated." - }, - "SequenceNumber": { - "type": "string", - "description": "The version of the property. Every time a property is modified, its sequence number is increased." - } - } - }, - "PropertyCustomTypeId": { - "type": "string", - "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." - }, - "PropertyBatchDescriptionList": { - "type": "object", - "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.", - "properties": { - "Operations": { - "type": "array", - "items": { - "$ref": "#/definitions/PropertyBatchOperation" - }, - "description": "A list of the property batch operations to be executed." - } - } - }, - "PropertyBatchOperationKind": { - "type": "string", - "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.", - "enum": [ - "Invalid", - "Put", - "Get", - "CheckExists", - "CheckSequence", - "Delete", - "CheckValue" - ], - "x-ms-enum": { - "name": "PropertyBatchOperationKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Put", - "description": "The operation will create or edit a property. The value is 1." - }, - { - "value": "Get", - "description": "The operation will get a property. The value is 2." - }, - { - "value": "CheckExists", - "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3." - }, - { - "value": "CheckSequence", - "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4." - }, - { - "value": "Delete", - "description": "The operation will delete a property. The value is 5." - }, - { - "value": "CheckValue", - "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7." - } - ] - } - }, - "PropertyBatchOperation": { - "type": "object", - "discriminator": "Kind", - "description": "Represents the base type for property operations that can be put into a batch and submitted.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyBatchOperationKind", - "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values." - }, - "PropertyName": { - "$ref": "#/definitions/PropertyName", - "description": "The name of the Service Fabric property." - } - }, - "required": [ - "Kind", - "PropertyName" - ] - }, - "CheckExistsPropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckExistsPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckExists", - "properties": { - "Exists": { - "type": "boolean", - "description": "Whether or not the property should exist for the operation to pass." - } - }, - "required": [ - "Exists" - ] - }, - "CheckSequencePropertyBatchOperation": { - "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckSequencePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckSequence", - "properties": { - "SequenceNumber": { - "type": "string", - "description": "The expected sequence number." - } - }, - "required": [ - "SequenceNumber" - ] - }, - "CheckValuePropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "CheckValuePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "CheckValue", - "properties": { - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "The expected property value." - } - }, - "required": [ - "Value" - ] - }, - "DeletePropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "DeletePropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Delete" - }, - "GetPropertyBatchOperation": { - "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "GetPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Get", - "properties": { - "IncludeValue": { - "type": "boolean", - "default": false, - "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata." - } - } - }, - "PutPropertyBatchOperation": { - "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchOperation" - }, - { - "type": "object", - "description": "PutPropertyBatchOperation" - } - ], - "x-ms-discriminator-value": "Put", - "properties": { - "Value": { - "$ref": "#/definitions/PropertyValue", - "description": "Describes a Service Fabric property value." - }, - "CustomTypeId": { - "$ref": "#/definitions/PropertyCustomTypeId", - "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." - } - }, - "required": [ - "Value" - ] - }, - "PropertyBatchInfoKind": { - "type": "string", - "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.", - "enum": [ - "Invalid", - "Successful", - "Failed" - ], - "x-ms-enum": { - "name": "PropertyBatchInfoKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Successful", - "description": "The property batch succeeded." - }, - { - "value": "Failed", - "description": "The property batch failed." - } - ] - } - }, - "PropertyBatchInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Information about the results of a property batch.", - "properties": { - "Kind": { - "$ref": "#/definitions/PropertyBatchInfoKind", - "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values." - } - }, - "required": [ - "Kind" - ] - }, - "SuccessfulPropertyBatchInfo": { - "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchInfo" - }, - { - "type": "object", - "description": "SuccessfulPropertyBatchInfo" - } - ], - "x-ms-discriminator-value": "Successful", - "properties": { - "Properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PropertyInfo" - }, - "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map." - } - } - }, - "FailedPropertyBatchInfo": { - "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.", - "allOf": [ - { - "$ref": "#/definitions/PropertyBatchInfo" - }, - { - "type": "object", - "description": "FailedPropertyBatchInfo" - } - ], - "x-ms-discriminator-value": "Failed", - "properties": { - "ErrorMessage": { - "type": "string", - "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch." - }, - "OperationIndex": { - "type": "integer", - "description": "The index of the unsuccessful operation in the property batch." - } - } - }, - "EntityKind": { - "type": "string", - "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", - "enum": [ - "Invalid", - "Node", - "Partition", - "Service", - "Application", - "Replica", - "DeployedApplication", - "DeployedServicePackage", - "Cluster" - ], - "x-ms-enum": { - "name": "EntityKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Node", - "description": "Indicates the entity is a Service Fabric node. The value is 1." - }, - { - "value": "Partition", - "description": "Indicates the entity is a Service Fabric partition. The value is 2." - }, - { - "value": "Service", - "description": "Indicates the entity is a Service Fabric service. The value is 3." - }, - { - "value": "Application", - "description": "Indicates the entity is a Service Fabric application. The value is 4." - }, - { - "value": "Replica", - "description": "Indicates the entity is a Service Fabric replica. The value is 5." - }, - { - "value": "DeployedApplication", - "description": "Indicates the entity is a Service Fabric deployed application. The value is 6." - }, - { - "value": "DeployedServicePackage", - "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7." - }, - { - "value": "Cluster", - "description": "Indicates the entity is a Service Fabric cluster. The value is 8." - } - ] - } - }, - "HealthStateCount": { - "type": "object", - "description": "Represents information about how many health entities are in Ok, Warning and Error health state.", - "properties": { - "OkCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Ok.", - "minimum": 0 - }, - "WarningCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Warning.", - "minimum": 0 - }, - "ErrorCount": { - "type": "integer", - "format": "int64", - "description": "The number of health entities with aggregated health state Error.", - "minimum": 0 - } - } - }, - "EntityKindHealthStateCount": { - "type": "object", - "description": "Represents health state count for entities of the specified entity kind.", - "properties": { - "EntityKind": { - "$ref": "#/definitions/EntityKind", - "description": "The entity kind for which health states are evaluated." - }, - "HealthStateCount": { - "$ref": "#/definitions/HealthStateCount", - "description": "The health state count for the entities of the specified kind." - } - } - }, - "HealthStatistics": { - "type": "object", - "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.", - "properties": { - "HealthStateCountList": { - "type": "array", - "items": { - "$ref": "#/definitions/EntityKindHealthStateCount" - }, - "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state." - } - } - }, - "BackupPolicyDescription": { - "type": "object", - "description": "Describes a backup policy for configuring periodic backup.", - "required": [ - "Name", - "AutoRestoreOnDataLoss", - "Schedule", - "MaxIncrementalBackups", - "Storage" - ], - "properties": { - "Name": { - "type": "string", - "description": "The unique name identifying this backup policy." - }, - "AutoRestoreOnDataLoss": { - "type": "boolean", - "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event." - }, - "MaxIncrementalBackups": { - "type": "integer", - "minimum": 0, - "maximum": 255, - "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit." - }, - "Schedule": { - "$ref": "#/definitions/BackupScheduleDescription", - "description": "Describes the backup schedule parameters." - }, - "Storage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Describes the details of backup storage where to store the periodic backups." - } - } - }, - "PagedBackupPolicyDescriptionList": { - "type": "object", - "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "The list of backup policies information.", - "items": { - "$ref": "#/definitions/BackupPolicyDescription" - } - } - } - }, - "BackupStorageDescription": { - "type": "object", - "required": [ - "StorageKind" - ], - "discriminator": "StorageKind", - "properties": { - "StorageKind": { - "$ref": "#/definitions/BackupStorageKind", - "description": "The kind of backup storage, where backups are saved." - }, - "FriendlyName": { - "type": "string", - "description": "Friendly name for this backup storage." - } - }, - "description": "Describes the parameters for the backup storage." - }, - "BackupStorageKind": { - "type": "string", - "description": "The kind of backup storage, where backups are saved.", - "enum": [ - "Invalid", - "FileShare", - "AzureBlobStore" - ], - "x-ms-enum": { - "name": "BackupStorageKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "FileShare", - "description": "Indicates file/ SMB share to be used as backup storage." - }, - { - "value": "AzureBlobStore", - "description": "Indicates Azure blob store to be used as backup storage." - } - ] - } - }, - "BackupScheduleDescription": { - "type": "object", - "description": "Describes the backup schedule parameters.", - "required": [ - "ScheduleKind" - ], - "discriminator": "ScheduleKind", - "properties": { - "ScheduleKind": { - "$ref": "#/definitions/BackupScheduleKind", - "description": "The kind of backup schedule, time based or frequency based." - } - } - }, - "BackupScheduleKind": { - "type": "string", - "description": "The kind of backup schedule, time based or frequency based.", - "enum": [ - "Invalid", - "TimeBased", - "FrequencyBased" - ], - "x-ms-enum": { - "name": "BackupScheduleKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "TimeBased", - "description": "Indicates a time-based backup schedule." - }, - { - "value": "FrequencyBased", - "description": "Indicates a frequency-based backup schedule." - } - ] - } - }, - "ApplicationBackupConfigurationInfo": { - "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Application backup configuration information.", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Application" - }, - "ServiceBackupConfigurationInfo": { - "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Service backup configuration info", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Service" - }, - "PagedBackupConfigurationInfoList": { - "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup configuration information.", - "items": { - "$ref": "#/definitions/BackupConfigurationInfo" - } - } - } - }, - "BackupPolicyScope": { - "type": "string", - "description": "Specifies the scope at which the backup policy is applied.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupPolicyScope", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level." - }, - { - "value": "Service", - "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level." - }, - { - "value": "Application", - "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level." - } - ] - } - }, - "BackupSuspensionScope": { - "type": "string", - "description": "Specifies the scope at which the backup suspension was applied.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupSuspensionScope", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the backup suspension is applied at partition level." - }, - { - "value": "Service", - "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup." - }, - { - "value": "Application", - "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup." - } - ] - } - }, - "RestorePartitionDescription": { - "type": "object", - "description": "Specifies the parameters needed to trigger a restore of a specific partition.", - "required": [ - "BackupId", - "BackupLocation" - ], - "properties": { - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique backup ID." - }, - "BackupLocation": { - "type": "string", - "description": "Location of the backup relative to the backup storage specified/ configured." - }, - "BackupStorage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Location of the backup from where the partition will be restored." - } - } - }, - "RestoreProgressInfo": { - "type": "object", - "description": "Describes the progress of a restore operation on a partition.", - "properties": { - "RestoreState": { - "$ref": "#/definitions/RestoreState", - "description": "Represents the current state of the partition restore operation." - }, - "TimeStampUtc": { - "type": "string", - "format": "date-time", - "description": "Timestamp when operation succeeded or failed." - }, - "RestoredEpoch": { - "$ref": "#/definitions/BackupEpoch", - "description": "Describes the epoch at which the partition is restored." - }, - "RestoredLsn": { - "type": "string", - "description": "Restored LSN." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in performing restore operation." - } - } - }, - "RestoreState": { - "type": "string", - "description": "Represents the current state of the partition restore operation.", - "enum": [ - "Invalid", - "Accepted", - "RestoreInProgress", - "Success", - "Failure", - "Timeout" - ], - "x-ms-enum": { - "name": "RestoreState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Accepted", - "description": "Operation has been validated and accepted. Restore is yet to be triggered." - }, - { - "value": "RestoreInProgress", - "description": "Restore operation has been triggered and is under process." - }, - { - "value": "Success", - "description": "Operation completed with success." - }, - { - "value": "Failure", - "description": "Operation completed with failure." - }, - { - "value": "Timeout", - "description": "Operation timed out." - } - ] - } - }, - "BackupPartitionDescription": { - "type": "object", - "description": "Describes the parameters for triggering partition's backup.", - "properties": { - "BackupStorage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Specifies the details of the backup storage where to save the backup." - } - } - }, - "BackupInfo": { - "type": "object", - "description": "Represents a backup point which can be used to trigger a restore.", - "properties": { - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique backup ID ." - }, - "BackupChainId": { - "type": "string", - "format": "uuid", - "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups." - }, - "ApplicationName": { - "type": "string", - "description": "Name of the Service Fabric application this partition backup belongs to." - }, - "ServiceName": { - "type": "string", - "description": "Name of the Service Fabric service this partition backup belongs to." - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation", - "description": "Information about the partition to which this backup belongs to" - }, - "BackupLocation": { - "type": "string", - "description": "Location of the backup, relative to the backup store." - }, - "BackupType": { - "$ref": "#/definitions/BackupType", - "description": "Describes the type of backup, whether its full or incremental." - }, - "EpochOfLastBackupRecord": { - "$ref": "#/definitions/BackupEpoch", - "description": "Epoch of the last record in this backup." - }, - "LsnOfLastBackupRecord": { - "type": "string", - "description": "LSN of the last record in this backup." - }, - "CreationTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The date time when this backup was taken." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in getting backup point information." - } - } - }, - "PagedBackupInfoList": { - "type": "object", - "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup information.", - "items": { - "$ref": "#/definitions/BackupInfo" - } - } - } - }, - "BackupType": { - "type": "string", - "description": "Describes the type of backup, whether its full or incremental.", - "enum": [ - "Invalid", - "Full", - "Incremental" - ], - "x-ms-enum": { - "name": "BackupType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Full", - "description": "Indicates a full backup." - }, - { - "value": "Incremental", - "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups." - } - ] - } - }, - "AzureBlobBackupStorageDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BackupStorageDescription" - }, - { - "type": "object" - }, - { - "description": "AzureBlobBackupStorageDescription" - } - ], - "x-ms-discriminator-value": "AzureBlobStore", - "required": [ - "ConnectionString", - "ContainerName" - ], - "properties": { - "ConnectionString": { - "type": "string", - "description": "The connection string to connect to the Azure blob store." - }, - "ContainerName": { - "type": "string", - "description": "The name of the container in the blob store to store and enumerate backups from." - } - }, - "description": "Describes the parameters for Azure blob store used for storing and enumerating backups." - }, - "FileShareBackupStorageDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/BackupStorageDescription" - }, - { - "type": "object" - }, - { - "description": "FileShareBackupStorageDescription" - } - ], - "x-ms-discriminator-value": "FileShare", - "required": [ - "Path" - ], - "description": "Describes the parameters for file share storage used for storing or enumerating backups.", - "properties": { - "Path": { - "type": "string", - "description": "UNC path of the file share where to store or enumerate backups from." - }, - "PrimaryUserName": { - "type": "string", - "description": "Primary user name to access the file share." - }, - "PrimaryPassword": { - "type": "string", - "description": "Primary password to access the share location." - }, - "SecondaryUserName": { - "type": "string", - "description": "Secondary user name to access the file share." - }, - "SecondaryPassword": { - "type": "string", - "description": "Secondary password to access the share location" - } - } - }, - "FrequencyBasedBackupScheduleDescription": { - "type": "object", - "description": "Describes the frequency based backup schedule.", - "allOf": [ - { - "$ref": "#/definitions/BackupScheduleDescription" - }, - { - "type": "object" - }, - { - "description": "FrequencyBasedBackupScheduleDescription" - } - ], - "x-ms-discriminator-value": "FrequencyBased", - "required": [ - "Interval" - ], - "properties": { - "Interval": { - "type": "string", - "format": "duration", - "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy." - } - } - }, - "TimeBasedBackupScheduleDescription": { - "type": "object", - "description": "Describes the time based backup schedule.", - "allOf": [ - { - "$ref": "#/definitions/BackupScheduleDescription" - }, - { - "type": "object" - }, - { - "description": "TimeBasedBackupScheduleDescription" - } - ], - "x-ms-discriminator-value": "TimeBased", - "required": [ - "ScheduleFrequencyType", - "RunTimes" - ], - "properties": { - "ScheduleFrequencyType": { - "$ref": "#/definitions/BackupScheduleFrequencyType", - "description": "Describes the frequency with which to run the time based backup schedule." - }, - "RunDays": { - "$ref": "#/definitions/DayOfWeekList", - "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." - }, - "RunTimes": { - "$ref": "#/definitions/TimeList", - "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." - } - } - }, - "BackupScheduleFrequencyType": { - "type": "string", - "description": "Describes the frequency with which to run the time based backup schedule.", - "enum": [ - "Invalid", - "Daily", - "Weekly" - ], - "x-ms-enum": { - "name": "BackupScheduleFrequencyType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Daily", - "description": "Indicates that the time based backup schedule is repeated at a daily frequency." - }, - { - "value": "Weekly", - "description": "Indicates that the time based backup schedule is repeated at a weekly frequency." - } - ] - } - }, - "TimeList": { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." - }, - "DayOfWeekList": { - "type": "array", - "items": { - "$ref": "#/definitions/DayOfWeek" - }, - "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." - }, - "DayOfWeek": { - "type": "string", - "description": "Describes the days in a week.", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": true, - "values": [ - { - "value": "Sunday", - "description": "Indicates the Day referred is Sunday." - }, - { - "value": "Monday", - "description": "Indicates the Day referred is Monday." - }, - { - "value": "Tuesday", - "description": "Indicates the Day referred is Tuesday." - }, - { - "value": "Wednesday", - "description": "Indicates the Day referred is Wednesday." - }, - { - "value": "Thursday", - "description": "Indicates the Day referred is Thursday." - }, - { - "value": "Friday", - "description": "Indicates the Day referred is Friday." - }, - { - "value": "Saturday", - "description": "Indicates the Day referred is Saturday." - } - ] - } - }, - "BackupProgressInfo": { - "type": "object", - "description": "Describes the progress of a partition's backup.", - "properties": { - "BackupState": { - "$ref": "#/definitions/BackupState", - "description": "Represents the current state of the partition backup operation." - }, - "TimeStampUtc": { - "type": "string", - "format": "date-time", - "description": "TimeStamp in UTC when operation succeeded or failed." - }, - "BackupId": { - "type": "string", - "format": "uuid", - "description": "Unique ID of the newly created backup." - }, - "BackupLocation": { - "type": "string", - "description": "Location, relative to the backup store, of the newly created backup." - }, - "EpochOfLastBackupRecord": { - "$ref": "#/definitions/BackupEpoch", - "description": "Specifies the epoch of the last record included in backup." - }, - "LsnOfLastBackupRecord": { - "type": "string", - "description": "The LSN of last record included in backup." - }, - "FailureError": { - "$ref": "#/definitions/FabricErrorError", - "description": "Denotes the failure encountered in performing backup operation." - } - } - }, - "BackupConfigurationInfo": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the backup configuration information.", - "properties": { - "Kind": { - "$ref": "#/definitions/BackupEntityKind", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." - }, - "PolicyName": { - "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.", - "type": "string" - }, - "PolicyInheritedFrom": { - "$ref": "#/definitions/BackupPolicyScope", - "description": "Specifies the scope at which the backup policy is applied." - }, - "SuspensionInfo": { - "$ref": "#/definitions/BackupSuspensionInfo", - "description": "Describes the backup suspension details." - } - }, - "required": [ - "Kind" - ] - }, - "PartitionBackupConfigurationInfo": { - "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.", - "allOf": [ - { - "$ref": "#/definitions/BackupConfigurationInfo" - }, - { - "type": "object", - "description": "Partition backup configuration info", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - } - ], - "x-ms-discriminator-value": "Partition" - }, - "BackupState": { - "type": "string", - "description": "Represents the current state of the partition backup operation.", - "enum": [ - "Invalid", - "Accepted", - "BackupInProgress", - "Success", - "Failure", - "Timeout" - ], - "x-ms-enum": { - "name": "BackupState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Accepted", - "description": "Operation has been validated and accepted. Backup is yet to be triggered." - }, - { - "value": "BackupInProgress", - "description": "Backup operation has been triggered and is under process." - }, - { - "value": "Success", - "description": "Operation completed with success." - }, - { - "value": "Failure", - "description": "Operation completed with failure." - }, - { - "value": "Timeout", - "description": "Operation timed out." - } - ] - } - }, - "BackupEntity": { - "type": "object", - "discriminator": "EntityKind", - "description": "Describes the Service Fabric entity that is configured for backup.", - "properties": { - "EntityKind": { - "$ref": "#/definitions/BackupEntityKind", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." - } - }, - "required": [ - "EntityKind" - ] - }, - "ApplicationBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric application which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "ApplicationBackupEntity", - "properties": { - "ApplicationName": { - "$ref": "#/definitions/ApplicationName", - "description": "The name of the application, including the 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Application" - }, - "ServiceBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric stateful service which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "ServiceBackupEntity", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - } - } - } - ], - "x-ms-discriminator-value": "Service" - }, - "PartitionBackupEntity": { - "type": "object", - "description": "Identifies the Service Fabric stateful partition which is being backed up.", - "allOf": [ - { - "$ref": "#/definitions/BackupEntity" - }, - { - "type": "object", - "description": "PartitionBackupEntity", - "properties": { - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - } - } - ], - "x-ms-discriminator-value": "Partition" - }, - "EnableBackupDescription": { - "description": "Specifies the parameters needed to enable periodic backup.", - "required": [ - "BackupPolicyName" - ], - "properties": { - "BackupPolicyName": { - "type": "string", - "description": "Name of the backup policy to be used for enabling periodic backups." - } - } - }, - "PagedBackupEntityList": { - "type": "object", - "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of backup entity information.", - "items": { - "$ref": "#/definitions/BackupEntity" - } - } - } - }, - "BackupSuspensionInfo": { - "type": "object", - "description": "Describes the backup suspension details.", - "properties": { - "IsSuspended": { - "type": "boolean", - "description": "Indicates whether periodic backup is suspended at this level or not." - }, - "SuspensionInheritedFrom": { - "$ref": "#/definitions/BackupSuspensionScope", - "description": "Specifies the scope at which the backup suspension was applied." - } - } - }, - "BackupEntityKind": { - "type": "string", - "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.", - "enum": [ - "Invalid", - "Partition", - "Service", - "Application" - ], - "x-ms-enum": { - "name": "BackupEntityKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "Partition", - "description": "Indicates the entity is a Service Fabric partition." - }, - { - "value": "Service", - "description": "Indicates the entity is a Service Fabric service." - }, - { - "value": "Application", - "description": "Indicates the entity is a Service Fabric application." - } - ] - } - }, - "GetBackupByStorageQueryDescription": { - "type": "object", - "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.", - "required": [ - "Storage", - "BackupEntity" - ], - "properties": { - "StartDateTimeFilter": { - "type": "string", - "format": "date-time", - "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning." - }, - "EndDateTimeFilter": { - "type": "string", - "format": "date-time", - "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end." - }, - "Latest": { - "type": "boolean", - "default": false, - "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity." - }, - "Storage": { - "$ref": "#/definitions/BackupStorageDescription", - "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore." - }, - "BackupEntity": { - "$ref": "#/definitions/BackupEntity", - "description": "Indicates the entity for which to enumerate backups." - } - } - }, - "NodeImpact": { - "type": "object", - "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "NodeName": { - "type": "string", - "description": "The name of the impacted node." - }, - "ImpactLevel": { - "type": "string", - "enum": [ - "Invalid", - "None", - "Restart", - "RemoveData", - "RemoveNode" - ], - "description": "The level of impact expected.", - "x-ms-enum": { - "name": "ImpactLevel", - "modelAsString": true, - "values": [ - { - "value": "Invalid" - }, - { - "value": "None" - }, - { - "value": "Restart" - }, - { - "value": "RemoveData" - }, - { - "value": "RemoveNode" - } - ] - } - } - }, - "required": [ - "NodeName" - ] - }, - "NodeRepairImpactDescription": { - "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "x-ms-discriminator-value": "Node", - "allOf": [ - { - "$ref": "#/definitions/RepairImpactDescriptionBase" - }, - { - "type": "object", - "description": "NodeRepairImpactDescription", - "properties": { - "NodeImpactList": { - "type": "array", - "items": { - "$ref": "#/definitions/NodeImpact" - }, - "description": "The list of nodes impacted by a repair action and their respective expected impact." - } - } - } - ] - }, - "NodeRepairTargetDescription": { - "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "x-ms-discriminator-value": "Node", - "allOf": [ - { - "$ref": "#/definitions/RepairTargetDescriptionBase" - }, - { - "type": "object", - "description": "NodeRepairTargetDescription", - "properties": { - "NodeNames": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of nodes targeted by a repair action." - } - } - } - ] - }, - "RepairImpactDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Kind": { - "$ref": "#/definitions/RepairImpactKind", - "description": "The kind of repair impact represented by the current object." - } - }, - "required": [ - "Kind" - ] - }, - "RepairImpactKind": { - "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", - "type": "string", - "enum": [ - "Invalid", - "Node" - ], - "x-ms-enum": { - "name": "RepairImpactKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The repair impact is not valid or is of an unknown type." - }, - { - "value": "Node", - "description": "The repair impact affects a set of Service Fabric nodes." - } - ] - } - }, - "RepairTargetDescriptionBase": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Kind": { - "$ref": "#/definitions/RepairTargetKind", - "description": "The kind of repair target described by the current object." - } - }, - "required": [ - "Kind" - ] - }, - "RepairTargetKind": { - "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", - "type": "string", - "enum": [ - "Invalid", - "Node" - ], - "x-ms-enum": { - "name": "RepairTargetKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "The repair target is not valid or is of an unknown type." - }, - { - "value": "Node", - "description": "The repair target is a set of Service Fabric nodes." - } - ] - } - }, - "RepairTask": { - "type": "object", - "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value." - }, - "Description": { - "type": "string", - "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set." - }, - "State": { - "type": "string", - "enum": [ - "Invalid", - "Created", - "Claimed", - "Preparing", - "Approved", - "Executing", - "Restoring", - "Completed" - ], - "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.", - "x-ms-enum": { - "name": "State", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value." - }, - { - "value": "Created", - "description": "Indicates that the repair task has been created." - }, - { - "value": "Claimed", - "description": "Indicates that the repair task has been claimed by a repair executor." - }, - { - "value": "Preparing", - "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully." - }, - { - "value": "Approved", - "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute." - }, - { - "value": "Executing", - "description": "Indicates that execution of the repair task is in progress." - }, - { - "value": "Restoring", - "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online." - }, - { - "value": "Completed", - "description": "Indicates that the repair task has completed, and no further state changes will occur." - } - ] - } - }, - "Flags": { - "type": "integer", - "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request" - }, - "Action": { - "type": "string", - "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set." - }, - "Target": { - "$ref": "#/definitions/RepairTargetDescriptionBase", - "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set." - }, - "Executor": { - "type": "string", - "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set." - }, - "ExecutorData": { - "type": "string", - "description": "A data string that the repair executor can use to store its internal state." - }, - "Impact": { - "$ref": "#/definitions/RepairImpactDescriptionBase", - "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set." - }, - "ResultStatus": { - "type": "string", - "enum": [ - "Invalid", - "Succeeded", - "Cancelled", - "Interrupted", - "Failed", - "Pending" - ], - "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.", - "x-ms-enum": { - "name": "ResultStatus", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value." - }, - { - "value": "Succeeded", - "description": "Indicates that the repair task completed execution successfully." - }, - { - "value": "Cancelled", - "description": "Indicates that the repair task was cancelled prior to execution." - }, - { - "value": "Interrupted", - "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed." - }, - { - "value": "Failed", - "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed." - }, - { - "value": "Pending", - "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing." - } - ] - } - }, - "ResultCode": { - "type": "integer", - "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." - }, - "ResultDetails": { - "type": "string", - "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." - }, - "History": { - "$ref": "#/definitions/RepairTaskHistory", - "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified." - }, - "PreparingHealthCheckState": { - "$ref": "#/definitions/RepairTaskHealthCheckState", - "description": "The workflow state of the health check when the repair task is in the Preparing state." - }, - "RestoringHealthCheckState": { - "$ref": "#/definitions/RepairTaskHealthCheckState", - "description": "The workflow state of the health check when the repair task is in the Restoring state." - }, - "PerformPreparingHealthCheck": { - "type": "boolean", - "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state." - }, - "PerformRestoringHealthCheck": { - "type": "boolean", - "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state." - } - }, - "required": [ - "TaskId", - "Action", - "State" - ] - }, - "RepairTaskApproveDescription": { - "type": "object", - "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskCancelDescription": { - "type": "object", - "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - }, - "RequestAbort": { - "type": "boolean", - "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskDeleteDescription": { - "type": "object", - "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the completed repair task to be deleted." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskHealthCheckState": { - "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "type": "string", - "enum": [ - "NotStarted", - "InProgress", - "Succeeded", - "Skipped", - "TimedOut" - ], - "x-ms-enum": { - "name": "RepairTaskHealthCheckState", - "modelAsString": true, - "values": [ - { - "value": "NotStarted", - "description": "Indicates that the health check has not started." - }, - { - "value": "InProgress", - "description": "Indicates that the health check is in progress." - }, - { - "value": "Succeeded", - "description": "Indicates that the health check succeeded." - }, - { - "value": "Skipped", - "description": "Indicates that the health check was skipped." - }, - { - "value": "TimedOut", - "description": "Indicates that the health check timed out." - } - ] - } - }, - "RepairTaskHistory": { - "type": "object", - "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "CreatedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Created state." - }, - "ClaimedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Claimed state." - }, - "PreparingUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Preparing state." - }, - "ApprovedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Approved state" - }, - "ExecutingUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Executing state" - }, - "RestoringUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Restoring state" - }, - "CompletedUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task entered the Completed state" - }, - "PreparingHealthCheckStartUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task started the health check in the Preparing state." - }, - "PreparingHealthCheckEndUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task completed the health check in the Preparing state." - }, - "RestoringHealthCheckStartUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task started the health check in the Restoring state." - }, - "RestoringHealthCheckEndUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "The time when the repair task completed the health check in the Restoring state." - } - } - }, - "RepairTaskList": { - "type": "array", - "description": "A list of repair tasks.", - "items": { - "$ref": "#/definitions/RepairTask" - } - }, - "RepairTaskUpdateHealthPolicyDescription": { - "type": "object", - "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "TaskId": { - "type": "string", - "description": "The ID of the repair task to be updated." - }, - "Version": { - "type": "string", - "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed." - }, - "PerformPreparingHealthCheck": { - "type": "boolean", - "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." - }, - "PerformRestoringHealthCheck": { - "type": "boolean", - "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." - } - }, - "required": [ - "TaskId" - ] - }, - "RepairTaskUpdateInfo": { - "type": "object", - "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", - "properties": { - "Version": { - "type": "string", - "description": "The new version of the repair task." - } - }, - "required": [ - "Version" - ] - }, - "ReconfigurationInformation": { - "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.", - "properties": { - "PreviousConfigurationRole": { - "$ref": "#/definitions/ReplicaRole", - "description": "Replica role before reconfiguration started." - }, - "ReconfigurationPhase": { - "$ref": "#/definitions/ReconfigurationPhase", - "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." - }, - "ReconfigurationType": { - "$ref": "#/definitions/ReconfigurationType", - "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." - }, - "ReconfigurationStartTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time." - } - } - }, - "ReconfigurationPhase": { - "type": "string", - "description": "The reconfiguration phase of a replica of a stateful service.", - "enum": [ - "Unknown", - "None", - "Phase0", - "Phase1", - "Phase2", - "Phase3", - "Phase4", - "AbortPhaseZero" - ], - "x-ms-enum": { - "name": "ReconfigurationPhase", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the invalid reconfiguration phase." - }, - { - "value": "None", - "description": "Specifies that there is no reconfiguration in progress." - }, - { - "value": "Phase0", - "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary." - }, - { - "value": "Phase1", - "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress." - }, - { - "value": "Phase2", - "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set." - }, - { - "value": "Phase3", - "description": "This phase is for internal use only." - }, - { - "value": "Phase4", - "description": "This phase is for internal use only." - }, - { - "value": "AbortPhaseZero", - "description": "This phase is for internal use only." - } - ] - } - }, - "ReconfigurationType": { - "type": "string", - "description": "The type of reconfiguration for replica of a stateful service.", - "enum": [ - "Unknown", - "SwapPrimary", - "Failover", - "Other" - ], - "x-ms-enum": { - "name": "ReconfigurationType", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the invalid reconfiguration type." - }, - { - "value": "SwapPrimary", - "description": "Specifies that the primary replica is being swapped with a different replica." - }, - { - "value": "Failover", - "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc." - }, - { - "value": "Other", - "description": "Reconfigurations where the primary replica is not changing." - } - ] - } - }, - "InfrastructureServiceResponse": { - "type": "string", - "format": "binary", - "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service." - }, - "UploadChunkRange": { - "type": "object", - "description": "Information about which portion of the file to upload.", - "properties": { - "StartPosition": { - "type": "string", - "description": "The start position of the portion of the file. It's represented by the number of bytes." - }, - "EndPosition": { - "type": "string", - "description": "The end position of the portion of the file. It's represented by the number of bytes." - } - } - }, - "UploadSessionInfo": { - "type": "object", - "description": "Information about an image store upload session. A session is associated with a relative path in the image store.", - "properties": { - "StoreRelativePath": { - "type": "string", - "description": "The remote location within image store. This path is relative to the image store root." - }, - "SessionId": { - "type": "string", - "format": "uuid", - "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed." - }, - "ModifiedDate": { - "type": "string", - "format": "date-time", - "description": "The date and time when the upload session was last modified." - }, - "FileSize": { - "type": "string", - "description": "The size in bytes of the uploading file." - }, - "ExpectedRanges": { - "type": "array", - "items": { - "$ref": "#/definitions/UploadChunkRange" - }, - "description": "List of chunk ranges that image store has not received yet." - } - } - }, - "UploadSession": { - "type": "object", - "description": "Information about a image store upload session", - "properties": { - "UploadSessions": { - "type": "array", - "items": { - "$ref": "#/definitions/UploadSessionInfo" - }, - "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions." - } - } - }, - "ContainerLogs": { - "type": "object", - "description": "Container logs.", - "properties": { - "Content": { - "type": "string", - "description": "Container logs." - } - } - }, - "ScalingPolicyDescription": { - "type": "object", - "description": "Describes how the scaling should be performed", - "required": [ - "ScalingTrigger", - "ScalingMechanism" - ], - "properties": { - "ScalingTrigger": { - "$ref": "#/definitions/ScalingTriggerDescription", - "description": "Specifies the trigger associated with this scaling policy" - }, - "ScalingMechanism": { - "$ref": "#/definitions/ScalingMechanismDescription", - "description": "Specifies the mechanism associated with this scaling policy" - } - } - }, - "ScalingPolicyDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ScalingPolicyDescription" - }, - "description": "A list that describes the scaling policies." - }, - "ScalingTriggerDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the trigger for performing a scaling operation.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ScalingTriggerKind", - "description": "Specifies the kind of scaling trigger" - } - } - }, - "ScalingMechanismDescription": { - "type": "object", - "discriminator": "Kind", - "description": "Describes the mechanism for performing a scaling operation.", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "$ref": "#/definitions/ScalingMechanismKind", - "description": "Specifies the kind of scaling mechanism" - } - } - }, - "ScalingTriggerKind": { - "type": "string", - "description": "Enumerates the ways that a service can be scaled.", - "enum": [ - "Invalid", - "AveragePartitionLoad", - "AverageServiceLoad" - ], - "x-ms-enum": { - "name": "ScalingTriggerKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "AveragePartitionLoad", - "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1." - }, - { - "value": "AverageServiceLoad", - "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2." - } - ] - } - }, - "ScalingMechanismKind": { - "type": "string", - "description": "Enumerates the ways that a service can be scaled.", - "enum": [ - "Invalid", - "PartitionInstanceCount", - "AddRemoveIncrementalNamedPartition" - ], - "x-ms-enum": { - "name": "ScalingMechanismKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "PartitionInstanceCount", - "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1." - }, - { - "value": "AddRemoveIncrementalNamedPartition", - "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2." - } - ] - } - }, - "AveragePartitionLoadScalingTrigger": { - "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", - "allOf": [ - { - "$ref": "#/definitions/ScalingTriggerDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AveragePartitionLoad", - "required": [ - "MetricName", - "LowerLoadThreshold", - "UpperLoadThreshold", - "ScaleIntervalInSeconds" - ], - "properties": { - "MetricName": { - "type": "string", - "description": "The name of the metric for which usage should be tracked." - }, - "LowerLoadThreshold": { - "type": "string", - "format": "double", - "description": "The lower limit of the load below which a scale in operation should be performed." - }, - "UpperLoadThreshold": { - "type": "string", - "format": "double", - "description": "The upper limit of the load beyond which a scale out operation should be performed." - }, - "ScaleIntervalInSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The period in seconds on which a decision is made whether to scale or not." - } - } - }, - "AverageServiceLoadScalingTrigger": { - "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", - "allOf": [ - { - "$ref": "#/definitions/ScalingTriggerDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AverageServiceLoad", - "required": [ - "MetricName", - "LowerLoadThreshold", - "UpperLoadThreshold", - "ScaleIntervalInSeconds" - ], - "properties": { - "MetricName": { - "type": "string", - "description": "The name of the metric for which usage should be tracked." - }, - "LowerLoadThreshold": { - "type": "string", - "format": "double", - "description": "The lower limit of the load below which a scale in operation should be performed." - }, - "UpperLoadThreshold": { - "type": "string", - "format": "double", - "description": "The upper limit of the load beyond which a scale out operation should be performed." - }, - "ScaleIntervalInSeconds": { - "type": "integer", - "format": "int64", - "minimum": 0, - "maximum": 4294967295, - "description": "The period in seconds on which a decision is made whether to scale or not." - } - } - }, - "PartitionInstanceCountScaleMechanism": { - "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", - "allOf": [ - { - "$ref": "#/definitions/ScalingMechanismDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "PartitionInstanceCount", - "required": [ - "MinInstanceCount", - "MaxInstanceCount", - "ScaleIncrement" - ], - "properties": { - "MinInstanceCount": { - "type": "integer", - "description": "Minimum number of instances of the partition." - }, - "MaxInstanceCount": { - "type": "integer", - "description": "Maximum number of instances of the partition." - }, - "ScaleIncrement": { - "type": "integer", - "description": "The number of instances to add or remove during a scaling operation." - } - } - }, - "AddRemoveIncrementalNamedPartitionScalingMechanism": { - "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'", - "allOf": [ - { - "$ref": "#/definitions/ScalingMechanismDescription" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", - "required": [ - "MinPartitionCount", - "MaxPartitionCount", - "ScaleIncrement" - ], - "properties": { - "MinPartitionCount": { - "type": "integer", - "description": "Minimum number of named partitions of the service." - }, - "MaxPartitionCount": { - "type": "integer", - "description": "Maximum number of named partitions of the service." - }, - "ScaleIncrement": { - "type": "integer", - "description": "The number of instances to add or remove during a scaling operation." - } - } - }, - "ApplicationCreatedEvent": { - "description": "Application Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "ApplicationDefinitionKind": { - "type": "string", - "description": "Application definition kind." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "ApplicationDefinitionKind" - ] - } - ], - "x-ms-discriminator-value": "ApplicationCreated" - }, - "ApplicationDeletedEvent": { - "description": "Application Deleted event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion" - ] - } - ], - "x-ms-discriminator-value": "ApplicationDeleted" - }, - "ApplicationHealthReportCreatedEvent": { - "description": "Application Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ApplicationHealthReportCreated" - }, - "ApplicationHealthReportExpiredEvent": { - "description": "Application Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ApplicationHealthReportExpired" - }, - "ApplicationUpgradeCompleteEvent": { - "description": "Application Upgrade Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeComplete" - }, - "ApplicationUpgradeDomainCompleteEvent": { - "description": "Application Upgrade Domain Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "UpgradeState": { - "type": "string", - "description": "State of upgrade." - }, - "UpgradeDomains": { - "type": "string", - "description": "Upgrade domains." - }, - "UpgradeDomainElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Upgrade time of domain in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "UpgradeState", - "UpgradeDomains", - "UpgradeDomainElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeDomainComplete" - }, - "ApplicationUpgradeRollbackCompleteEvent": { - "description": "Application Upgrade Rollback Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Application type version." - }, - "FailureReason": { - "type": "string", - "description": "Describes reason of failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "ApplicationTypeVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeRollbackComplete" - }, - "ApplicationUpgradeRollbackStartEvent": { - "description": "Application Upgrade Rollback Start event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "FailureReason": { - "type": "string", - "description": "Describes reason of failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall upgrade time in milli-seconds." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeRollbackStart" - }, - "ApplicationUpgradeStartEvent": { - "description": "Application Upgrade Start event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "CurrentApplicationTypeVersion": { - "type": "string", - "description": "Current Application type version." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "Target Application type version." - }, - "UpgradeType": { - "type": "string", - "description": "Type of upgrade." - }, - "RollingUpgradeMode": { - "type": "string", - "description": "Mode of upgrade." - }, - "FailureAction": { - "type": "string", - "description": "Action if failed." - } - }, - "required": [ - "ApplicationTypeName", - "CurrentApplicationTypeVersion", - "ApplicationTypeVersion", - "UpgradeType", - "RollingUpgradeMode", - "FailureAction" - ] - } - ], - "x-ms-discriminator-value": "ApplicationUpgradeStart" - }, - "DeployedApplicationHealthReportCreatedEvent": { - "description": "Deployed Application Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedApplicationHealthReportCreated" - }, - "DeployedApplicationHealthReportExpiredEvent": { - "description": "Deployed Application Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ApplicationInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Application instance." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ApplicationInstanceId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired" - }, - "ProcessDeactivatedEvent": { - "description": "Process Deactivated event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceName": { - "type": "string", - "description": "Name of Service." - }, - "ServicePackageName": { - "type": "string", - "description": "Name of Service package." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Activation Id of Service package." - }, - "IsExclusive": { - "type": "boolean", - "description": "Indicates IsExclusive flag." - }, - "CodePackageName": { - "type": "string", - "description": "Name of Code package." - }, - "EntryPointType": { - "type": "string", - "description": "Type of EntryPoint." - }, - "ExeName": { - "type": "string", - "description": "Name of executable." - }, - "ProcessId": { - "type": "integer", - "format": "int64", - "description": "Process Id." - }, - "HostId": { - "type": "string", - "description": "Host Id." - }, - "ExitCode": { - "type": "integer", - "format": "int64", - "description": "Exit code of process." - }, - "UnexpectedTermination": { - "type": "boolean", - "description": "Indicates if termination is unexpected." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time of process." - } - }, - "required": [ - "ServiceName", - "ServicePackageName", - "ServicePackageActivationId", - "IsExclusive", - "CodePackageName", - "EntryPointType", - "ExeName", - "ProcessId", - "HostId", - "ExitCode", - "UnexpectedTermination", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "ProcessDeactivated" - }, - "ContainerDeactivatedEvent": { - "description": "Container Deactivated event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceName": { - "type": "string", - "description": "Name of Service." - }, - "ServicePackageName": { - "type": "string", - "description": "Name of Service package." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Activation Id of Service package." - }, - "IsExclusive": { - "type": "boolean", - "description": "Indicates IsExclusive flag." - }, - "CodePackageName": { - "type": "string", - "description": "Name of Code package." - }, - "EntryPointType": { - "type": "string", - "description": "Type of EntryPoint." - }, - "ImageName": { - "type": "string", - "description": "Name of Container image." - }, - "ContainerName": { - "type": "string", - "description": "Name of Container." - }, - "HostId": { - "type": "string", - "description": "Host Id." - }, - "ExitCode": { - "type": "integer", - "format": "int64", - "description": "Exit code of process." - }, - "UnexpectedTermination": { - "type": "boolean", - "description": "Indicates if termination is unexpected." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time of process." - } - }, - "required": [ - "ServiceName", - "ServicePackageName", - "ServicePackageActivationId", - "IsExclusive", - "CodePackageName", - "EntryPointType", - "ImageName", - "ContainerName", - "HostId", - "ExitCode", - "UnexpectedTermination", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "ContainerDeactivated" - }, - "NodeAbortedEvent": { - "description": "Node Aborted event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeAborted" - }, - "NodeAbortingEvent": { - "description": "Node Aborting event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeAborting" - }, - "NodeAddedEvent": { - "description": "Node Added event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeType": { - "type": "string", - "description": "Type of Node." - }, - "FabricVersion": { - "type": "string", - "description": "Fabric version." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "NodeCapacities": { - "type": "string", - "description": "Capacities." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "NodeType", - "FabricVersion", - "IpAddressOrFQDN", - "NodeCapacities" - ] - } - ], - "x-ms-discriminator-value": "NodeAdded" - }, - "NodeCloseEvent": { - "description": "Node Close event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "string", - "description": "Id of Node instance." - }, - "Error": { - "type": "string", - "description": "Describes error." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "Error" - ] - } - ], - "x-ms-discriminator-value": "NodeClose" - }, - "NodeClosingEvent": { - "description": "Node Closing event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeClosing" - }, - "NodeDeactivateCompleteEvent": { - "description": "Node Deactivate Complete event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "EffectiveDeactivateIntent": { - "type": "string", - "description": "Describes deactivate intent." - }, - "BatchIdsWithDeactivateIntent": { - "type": "string", - "description": "Batch Ids." - }, - "StartTime": { - "type": "string", - "format": "date-time", - "description": "Start time." - } - }, - "required": [ - "NodeInstance", - "EffectiveDeactivateIntent", - "BatchIdsWithDeactivateIntent", - "StartTime" - ] - } - ], - "x-ms-discriminator-value": "NodeDeactivateComplete" - }, - "NodeDeactivateStartEvent": { - "description": "Node Deactivate Start event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "BatchId": { - "type": "string", - "description": "Batch Id." - }, - "DeactivateIntent": { - "type": "string", - "description": "Describes deactivate intent." - } - }, - "required": [ - "NodeInstance", - "BatchId", - "DeactivateIntent" - ] - } - ], - "x-ms-discriminator-value": "NodeDeactivateStart" - }, - "NodeDownEvent": { - "description": "Node Down event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "LastNodeUpAt": { - "type": "string", - "format": "date-time", - "description": "Time when Node was last up." - } - }, - "required": [ - "NodeInstance", - "LastNodeUpAt" - ] - } - ], - "x-ms-discriminator-value": "NodeDown" - }, - "NodeHealthReportCreatedEvent": { - "description": "Node Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "NodeInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "NodeHealthReportCreated" - }, - "NodeHealthReportExpiredEvent": { - "description": "Node Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "NodeInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "NodeHealthReportExpired" - }, - "NodeOpenedSuccessEvent": { - "description": "Node Opened Success event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeOpenedSuccess" - }, - "NodeOpenFailedEvent": { - "description": "Node Open Failed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - }, - "Error": { - "type": "string", - "description": "Describes the error." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion", - "Error" - ] - } - ], - "x-ms-discriminator-value": "NodeOpenFailed" - }, - "NodeOpeningEvent": { - "description": "Node Opening event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "UpgradeDomain": { - "type": "string", - "description": "Upgrade domain of Node." - }, - "FaultDomain": { - "type": "string", - "description": "Fault domain of Node." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "Hostname": { - "type": "string", - "description": "Name of Host." - }, - "IsSeedNode": { - "type": "boolean", - "description": "Indicates if it is seed node." - }, - "NodeVersion": { - "type": "string", - "description": "Version of Node." - } - }, - "required": [ - "NodeInstance", - "NodeId", - "UpgradeDomain", - "FaultDomain", - "IpAddressOrFQDN", - "Hostname", - "IsSeedNode", - "NodeVersion" - ] - } - ], - "x-ms-discriminator-value": "NodeOpening" - }, - "NodeRemovedEvent": { - "description": "Node Removed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeId": { - "type": "string", - "description": "Id of Node." - }, - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "NodeType": { - "type": "string", - "description": "Type of Node." - }, - "FabricVersion": { - "type": "string", - "description": "Fabric version." - }, - "IpAddressOrFQDN": { - "type": "string", - "description": "IP address or FQDN." - }, - "NodeCapacities": { - "type": "string", - "description": "Capacities." - } - }, - "required": [ - "NodeId", - "NodeInstance", - "NodeType", - "FabricVersion", - "IpAddressOrFQDN", - "NodeCapacities" - ] - } - ], - "x-ms-discriminator-value": "NodeRemoved" - }, - "NodeUpEvent": { - "description": "Node Up event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "LastNodeDownAt": { - "type": "string", - "format": "date-time", - "description": "Time when Node was last down." - } - }, - "required": [ - "NodeInstance", - "LastNodeDownAt" - ] - } - ], - "x-ms-discriminator-value": "NodeUp" - }, - "PartitionHealthReportCreatedEvent": { - "description": "Partition Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "PartitionHealthReportCreated" - }, - "PartitionHealthReportExpiredEvent": { - "description": "Partition Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "PartitionHealthReportExpired" - }, - "PartitionReconfigurationCompletedEvent": { - "description": "Partition Reconfiguration Completed event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "NodeInstanceId": { - "type": "string", - "description": "Id of Node instance." - }, - "ServiceType": { - "type": "string", - "description": "Type of Service." - }, - "CcEpochDataLossVersion": { - "type": "integer", - "format": "int64", - "description": "CcEpochDataLoss version." - }, - "CcEpochConfigVersion": { - "type": "integer", - "format": "int64", - "description": "CcEpochConfig version." - }, - "ReconfigType": { - "type": "string", - "description": "Type of reconfiguration." - }, - "Result": { - "type": "string", - "description": "Describes reconfiguration result." - }, - "Phase0DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase0 in milli-seconds." - }, - "Phase1DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase1 in milli-seconds." - }, - "Phase2DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase2 in milli-seconds." - }, - "Phase3DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase3 in milli-seconds." - }, - "Phase4DurationMs": { - "type": "number", - "format": "double", - "description": "Duration of Phase4 in milli-seconds." - }, - "TotalDurationMs": { - "type": "number", - "format": "double", - "description": "Total duration in milli-seconds." - } - }, - "required": [ - "NodeName", - "NodeInstanceId", - "ServiceType", - "CcEpochDataLossVersion", - "CcEpochConfigVersion", - "ReconfigType", - "Result", - "Phase0DurationMs", - "Phase1DurationMs", - "Phase2DurationMs", - "Phase3DurationMs", - "Phase4DurationMs", - "TotalDurationMs" - ] - } - ], - "x-ms-discriminator-value": "PartitionReconfigurationCompleted" - }, - "PartitionPrimaryMoveAnalysisEvent": { - "description": "Partition Primary Move Analysis event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionAnalysisEvent" - }, - { - "type": "object", - "properties": { - "WhenMoveCompleted": { - "type": "string", - "format": "date-time", - "description": "Time when the move was completed." - }, - "PreviousNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "CurrentNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "MoveReason": { - "type": "string", - "description": "Move reason." - }, - "RelevantTraces": { - "type": "string", - "description": "Relevant traces." - } - }, - "required": [ - "WhenMoveCompleted", - "PreviousNode", - "CurrentNode", - "MoveReason", - "RelevantTraces" - ] - } - ], - "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis" - }, - "ServiceCreatedEvent": { - "description": "Service Created event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Service type name." - }, - "ApplicationName": { - "type": "string", - "description": "Application name." - }, - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ServiceInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates if Service is stateful." - }, - "PartitionCount": { - "type": "integer", - "format": "int32", - "description": "Number of partitions." - }, - "TargetReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Size of target replicas set." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Minimum size of replicas set." - }, - "ServicePackageVersion": { - "type": "string", - "description": "Version of Service package." - }, - "PartitionId": { - "$ref": "#/definitions/PartitionId", - "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." - } - }, - "required": [ - "ServiceTypeName", - "ApplicationName", - "ApplicationTypeName", - "ServiceInstance", - "IsStateful", - "PartitionCount", - "TargetReplicaSetSize", - "MinReplicaSetSize", - "ServicePackageVersion", - "PartitionId" - ] - } - ], - "x-ms-discriminator-value": "ServiceCreated" - }, - "ServiceDeletedEvent": { - "description": "Service Deleted event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "ServiceTypeName": { - "type": "string", - "description": "Service type name." - }, - "ApplicationName": { - "type": "string", - "description": "Application name." - }, - "ApplicationTypeName": { - "type": "string", - "description": "Application type name." - }, - "ServiceInstance": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "IsStateful": { - "type": "boolean", - "description": "Indicates if Service is stateful." - }, - "PartitionCount": { - "type": "integer", - "format": "int32", - "description": "Number of partitions." - }, - "TargetReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Size of target replicas set." - }, - "MinReplicaSetSize": { - "type": "integer", - "format": "int32", - "description": "Minimum size of replicas set." - }, - "ServicePackageVersion": { - "type": "string", - "description": "Version of Service package." - } - }, - "required": [ - "ServiceTypeName", - "ApplicationName", - "ApplicationTypeName", - "ServiceInstance", - "IsStateful", - "PartitionCount", - "TargetReplicaSetSize", - "MinReplicaSetSize", - "ServicePackageVersion" - ] - } - ], - "x-ms-discriminator-value": "ServiceDeleted" - }, - "ServiceHealthReportCreatedEvent": { - "description": "Service Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "InstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "InstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ServiceHealthReportCreated" - }, - "ServiceHealthReportExpiredEvent": { - "description": "Service Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ServiceEvent" - }, - { - "type": "object", - "properties": { - "InstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "InstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ServiceHealthReportExpired" - }, - "DeployedServiceHealthReportCreatedEvent": { - "description": "Deployed Service Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "ServicePackageInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service package instance." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TTLTimespan": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ServiceManifestName", - "ServicePackageInstanceId", - "ServicePackageActivationId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TTLTimespan", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedServiceHealthReportCreated" - }, - "DeployedServiceHealthReportExpiredEvent": { - "description": "Deployed Service Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "ServiceManifest": { - "type": "string", - "description": "Service manifest name." - }, - "ServicePackageInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Service package instance." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TTLTimespan": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ServiceManifest", - "ServicePackageInstanceId", - "ServicePackageActivationId", - "NodeName", - "SourceId", - "Property", - "HealthState", - "TTLTimespan", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "DeployedServiceHealthReportExpired" - }, - "StatefulReplicaHealthReportCreatedEvent": { - "description": "Stateful Replica Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "ReplicaInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Replica instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ReplicaInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatefulReplicaHealthReportCreated" - }, - "StatefulReplicaHealthReportExpiredEvent": { - "description": "Stateful Replica Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "ReplicaInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Replica instance." - }, - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "ReplicaInstanceId", - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired" - }, - "StatelessReplicaHealthReportCreatedEvent": { - "description": "Stateless Replica Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatelessReplicaHealthReportCreated" - }, - "StatelessReplicaHealthReportExpiredEvent": { - "description": "Stateless Replica Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired" - }, - "ClusterHealthReportCreatedEvent": { - "description": "Cluster Health Report Created event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ClusterHealthReportCreated" - }, - "ClusterHealthReportExpiredEvent": { - "description": "Cluster Health Report Expired event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "SourceId": { - "type": "string", - "description": "Id of report source." - }, - "Property": { - "type": "string", - "description": "Describes the property." - }, - "HealthState": { - "type": "string", - "description": "Describes the property health state." - }, - "TimeToLiveMs": { - "type": "integer", - "format": "int64", - "description": "Time to live in milli-seconds." - }, - "SequenceNumber": { - "type": "integer", - "format": "int64", - "description": "Sequence number of report." - }, - "Description": { - "type": "string", - "description": "Description of report." - }, - "RemoveWhenExpired": { - "type": "boolean", - "description": "Indicates the removal when it expires." - }, - "SourceUtcTimestamp": { - "type": "string", - "format": "date-time", - "description": "Source time." - } - }, - "required": [ - "SourceId", - "Property", - "HealthState", - "TimeToLiveMs", - "SequenceNumber", - "Description", - "RemoveWhenExpired", - "SourceUtcTimestamp" - ] - } - ], - "x-ms-discriminator-value": "ClusterHealthReportExpired" - }, - "ClusterUpgradeCompleteEvent": { - "description": "Cluster Upgrade Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeComplete" - }, - "ClusterUpgradeDomainCompleteEvent": { - "description": "Cluster Upgrade Domain Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "UpgradeState": { - "type": "string", - "description": "State of upgrade." - }, - "UpgradeDomains": { - "type": "string", - "description": "Upgrade domains." - }, - "UpgradeDomainElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Duration of domain upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "UpgradeState", - "UpgradeDomains", - "UpgradeDomainElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeDomainComplete" - }, - "ClusterUpgradeRollbackCompleteEvent": { - "description": "Cluster Upgrade Rollback Complete event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "FailureReason": { - "type": "string", - "description": "Describes failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeRollbackComplete" - }, - "ClusterUpgradeRollbackStartEvent": { - "description": "Cluster Upgrade Rollback Start event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "FailureReason": { - "type": "string", - "description": "Describes failure." - }, - "OverallUpgradeElapsedTimeInMs": { - "type": "number", - "format": "double", - "description": "Overall duration of upgrade in milli-seconds." - } - }, - "required": [ - "TargetClusterVersion", - "FailureReason", - "OverallUpgradeElapsedTimeInMs" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeRollbackStart" - }, - "ClusterUpgradeStartEvent": { - "description": "Cluster Upgrade Start event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "CurrentClusterVersion": { - "type": "string", - "description": "Current Cluster version." - }, - "TargetClusterVersion": { - "type": "string", - "description": "Target Cluster version." - }, - "UpgradeType": { - "type": "string", - "description": "Type of upgrade." - }, - "RollingUpgradeMode": { - "type": "string", - "description": "Mode of upgrade." - }, - "FailureAction": { - "type": "string", - "description": "Action if failed." - } - }, - "required": [ - "CurrentClusterVersion", - "TargetClusterVersion", - "UpgradeType", - "RollingUpgradeMode", - "FailureAction" - ] - } - ], - "x-ms-discriminator-value": "ClusterUpgradeStart" - }, - "ChaosStoppedEvent": { - "description": "Chaos Stopped event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "Reason": { - "type": "string", - "description": "Describes reason." - } - }, - "required": [ - "Reason" - ] - } - ], - "x-ms-discriminator-value": "ChaosStopped" - }, - "ChaosStartedEvent": { - "description": "Chaos Started event.", - "allOf": [ - { - "$ref": "#/definitions/ClusterEvent" - }, - { - "type": "object", - "properties": { - "MaxConcurrentFaults": { - "type": "integer", - "format": "int64", - "description": "Maximum number of concurrent faults." - }, - "TimeToRunInSeconds": { - "type": "number", - "format": "double", - "description": "Time to run in seconds." - }, - "MaxClusterStabilizationTimeoutInSeconds": { - "type": "number", - "format": "double", - "description": "Maximum timeout for cluster stabilization in seconds." - }, - "WaitTimeBetweenIterationsInSeconds": { - "type": "number", - "format": "double", - "description": "Wait time between iterations in seconds." - }, - "WaitTimeBetweenFautlsInSeconds": { - "type": "number", - "format": "double", - "description": "Wait time between faults in seconds." - }, - "MoveReplicaFaultEnabled": { - "type": "boolean", - "description": "Indicates MoveReplica fault is enabled." - }, - "IncludedNodeTypeList": { - "type": "string", - "description": "List of included Node types." - }, - "IncludedApplicationList": { - "type": "string", - "description": "List of included Applications." - }, - "ClusterHealthPolicy": { - "type": "string", - "description": "Health policy." - }, - "ChaosContext": { - "type": "string", - "description": "Chaos Context." - } - }, - "required": [ - "MaxConcurrentFaults", - "TimeToRunInSeconds", - "MaxClusterStabilizationTimeoutInSeconds", - "WaitTimeBetweenIterationsInSeconds", - "WaitTimeBetweenFautlsInSeconds", - "MoveReplicaFaultEnabled", - "IncludedNodeTypeList", - "IncludedApplicationList", - "ClusterHealthPolicy", - "ChaosContext" - ] - } - ], - "x-ms-discriminator-value": "ChaosStarted" - }, - "ChaosRestartNodeFaultCompletedEvent": { - "description": "Chaos Restart Node Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - } - }, - "required": [ - "NodeInstanceId", - "FaultGroupId", - "FaultId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartNodeFaultCompleted" - }, - "ChaosRestartCodePackageFaultScheduledEvent": { - "description": "Chaos Restart Code Package Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "CodePackageName": { - "type": "string", - "description": "Code package name." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "NodeName", - "ServiceManifestName", - "CodePackageName", - "ServicePackageActivationId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartCodePackageFaultScheduled" - }, - "ChaosRestartCodePackageFaultCompletedEvent": { - "description": "Chaos Restart Code Package Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "NodeName": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ServiceManifestName": { - "type": "string", - "description": "Service manifest name." - }, - "CodePackageName": { - "type": "string", - "description": "Code package name." - }, - "ServicePackageActivationId": { - "type": "string", - "description": "Id of Service package activation." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "NodeName", - "ServiceManifestName", - "CodePackageName", - "ServicePackageActivationId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartCodePackageFaultCompleted" - }, - "ChaosRemoveReplicaFaultScheduledEvent": { - "description": "Chaos Remove Replica Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRemoveReplicaFaultScheduled" - }, - "ChaosRemoveReplicaFaultCompletedEvent": { - "description": "Chaos Remove Replica Fault Completed event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRemoveReplicaFaultCompleted" - }, - "ChaosMoveSecondaryFaultScheduledEvent": { - "description": "Chaos Move Secondary Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceName": { - "type": "string", - "description": "Service name." - }, - "SourceNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "DestinationNode": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ForcedMove": { - "type": "boolean", - "description": "Indicates a forced move." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceName", - "SourceNode", - "DestinationNode", - "ForcedMove" - ] - } - ], - "x-ms-discriminator-value": "ChaosMoveSecondaryFaultScheduled" - }, - "ChaosMovePrimaryFaultScheduledEvent": { - "description": "Chaos Move Primary Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/PartitionEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceName": { - "type": "string", - "description": "Service name." - }, - "NodeTo": { - "$ref": "#/definitions/NodeName", - "description": "The name of a Service Fabric node." - }, - "ForcedMove": { - "type": "boolean", - "description": "Indicates a forced move." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceName", - "NodeTo", - "ForcedMove" - ] - } - ], - "x-ms-discriminator-value": "ChaosMovePrimaryFaultScheduled" - }, - "ChaosRestartReplicaFaultScheduledEvent": { - "description": "Chaos Restart Replica Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/ReplicaEvent" - }, - { - "type": "object", - "properties": { - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - }, - "ServiceUri": { - "type": "string", - "description": "Service name." - } - }, - "required": [ - "FaultGroupId", - "FaultId", - "ServiceUri" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartReplicaFaultScheduled" - }, - "ChaosRestartNodeFaultScheduledEvent": { - "description": "Chaos Restart Node Fault Scheduled event.", - "allOf": [ - { - "$ref": "#/definitions/NodeEvent" - }, - { - "type": "object", - "properties": { - "NodeInstanceId": { - "type": "integer", - "format": "int64", - "description": "Id of Node instance." - }, - "FaultGroupId": { - "type": "string", - "format": "uuid", - "description": "Id of fault group." - }, - "FaultId": { - "type": "string", - "format": "uuid", - "description": "Id of fault." - } - }, - "required": [ - "NodeInstanceId", - "FaultGroupId", - "FaultId" - ] - } - ], - "x-ms-discriminator-value": "ChaosRestartNodeFaultScheduled" - }, - "ApplicationResourceDescription": { - "type": "object", - "description": "Describes a service fabric application resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationProperties", - "description": "This type describes properties of an application resource." - }, - "name": { - "$ref": "#/definitions/ApplicationResourceName", - "description": "Application resource name." - } - }, - "required": [ - "name", - "properties" - ] - }, - "ApplicationResourceName": { - "type": "string", - "description": "Application resource name." - }, - "PagedServiceResourceDescriptionList": { - "type": "object", - "description": "The list of service resources in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service resource description.", - "items": { - "$ref": "#/definitions/ServiceResourceDescription" - } - } - }, - "x-sf-clientlib": { - "TypeName": "PagedData", - "SkipGeneration": "true" - } - }, - "PagedServiceResourceReplicaDescriptionList": { - "type": "object", - "description": "The list of service resources in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", - "properties": { - "ContinuationToken": { - "$ref": "#/definitions/ContinuationToken", - "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." - }, - "Items": { - "type": "array", - "description": "List of service resource description.", - "items": { - "$ref": "#/definitions/ServiceResourceReplicaDescription" - } - } - }, - "x-sf-clientlib": { - "TypeName": "PagedData", - "SkipGeneration": "true" - } - }, - "ServiceResourceDescription": { - "type": "object", - "description": "Describes a service fabric service resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceResourceProperties", - "description": "This type describes properties of a service resource." - }, - "name": { - "$ref": "#/definitions/ServiceResourceName", - "description": "Service resource name." - } - }, - "required": [ - "name", - "properties" - ] - }, - "ServiceResourceName": { - "type": "string", - "description": "Service resource name." - }, - "ServiceResourceReplicaDescription": { - "type": "object", - "description": "Describes a replica of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceReplicaProperties" - }, - { - "type": "object", - "properties": { - "replicaName": { - "type": "string", - "description": "Name of the replica." - } - }, - "required": [ - "replicaName" - ] - } - ] - }, - "VolumeResourceName": { - "type": "string", - "description": "Volume resource name." - }, - "VolumeResourceDescription": { - "type": "object", - "description": "Describes a service fabric volume resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VolumeProperties", - "description": "This type describes properties of a volume resource." - }, - "name": { - "$ref": "#/definitions/VolumeResourceName", - "description": "Volume resource name." - } - }, - "required": [ - "name", - "properties" - ] - }, - "ApplicationProperties": { - "description": "This type describes properties of an application resource.", - "type": "object", - "properties": { - "description": { - "description": "User readable description of the application.", - "type": "string" - }, - "debugParams": { - "description": "Internal use.", - "type": "string" - }, - "services": { - "type": "array", - "description": "describes the services in the application.", - "items": { - "$ref": "#/definitions/ServiceResourceDescription" - } - }, - "healthState": { - "readOnly": true, - "$ref": "#/definitions/HealthState", - "description": "Describes the health state of an application resource." - }, - "unhealthyEvaluation": { - "readOnly": true, - "type": "string", - "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Status of the application resource.", - "enum": [ - "Invalid", - "Ready", - "Upgrading", - "Creating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationResourceStatus", - "modelAsString": true - } - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the application deployment." - }, - "serviceNames": { - "readOnly": true, - "description": "Names of the services in the application.", - "type": "array", - "items": { - "type": "string" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsDescription", - "description": "Describes the diagnostics definition and usage for an application resource." - } - } - }, - "ContainerCodePackageProperties": { - "description": "Describes a container and its runtime properties.", - "type": "object", - "properties": { - "name": { - "description": "The name of the code package.", - "type": "string" - }, - "image": { - "description": "The Container image to use.", - "type": "string" - }, - "imageRegistryCredential": { - "$ref": "#/definitions/ImageRegistryCredential", - "description": "Image registry credential." - }, - "entrypoint": { - "description": "Override for the default entry point in the container.", - "type": "string" - }, - "commands": { - "description": "Command array to execute within the container in exec form.", - "type": "array", - "items": { - "type": "string" - } - }, - "environmentVariables": { - "description": "The environment variables to set in this container", - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - } - }, - "settings": { - "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", - "type": "array", - "items": { - "$ref": "#/definitions/Setting" - } - }, - "labels": { - "description": "The labels to set in this container.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerLabel" - } - }, - "endpoints": { - "description": "The endpoints exposed by this container.", - "type": "array", - "items": { - "$ref": "#/definitions/EndpointProperties" - } - }, - "resources": { - "$ref": "#/definitions/ResourceRequirements", - "description": "This type describes the resource requirements for a container or a service." - }, - "volumeRefs": { - "description": "The volumes to be attached to the container.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerVolume" - } - }, - "instanceView": { - "readOnly": true, - "$ref": "#/definitions/ContainerInstanceView", - "description": "Runtime information of a container instance." - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsRef", - "description": "Reference to sinks in DiagnosticsDescription." - } - }, - "required": [ - "name", - "image", - "resources" - ] - }, - "ContainerEvent": { - "description": "A container event.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the container event." - }, - "count": { - "type": "integer", - "description": "The count of the event." - }, - "firstTimestamp": { - "type": "string", - "description": "Date/time of the first event." - }, - "lastTimestamp": { - "type": "string", - "description": "Date/time of the last event." - }, - "message": { - "type": "string", - "description": "The event message" - }, - "type": { - "type": "string", - "description": "The event type." - } - } - }, - "ContainerInstanceView": { - "description": "Runtime information of a container instance.", - "type": "object", - "properties": { - "restartCount": { - "type": "integer", - "description": "The number of times the container has been restarted." - }, - "currentState": { - "$ref": "#/definitions/ContainerState", - "description": "Current container instance state." - }, - "previousState": { - "$ref": "#/definitions/ContainerState", - "description": "Previous container instance state." - }, - "events": { - "description": "The events of this container instance.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerEvent" - } - } - } - }, - "ContainerLabel": { - "description": "Describes a container label.", - "type": "object", - "properties": { - "name": { - "description": "The name of the container label.", - "type": "string" - }, - "value": { - "description": "The value of the container label.", - "type": "string" - } - }, - "required": [ - "name", - "value" - ] - }, - "ContainerState": { - "description": "The container state.", - "type": "object", - "properties": { - "state": { - "type": "string", - "description": "The state of this container" - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Date/time when the container state started." - }, - "exitCode": { - "type": "string", - "description": "The container exit code." - }, - "finishTime": { - "type": "string", - "format": "date-time", - "description": "Date/time when the container state finished." - }, - "detailStatus": { - "description": "Human-readable status of this state.", - "type": "string" - } - } - }, - "ContainerVolume": { - "description": "Describes how a volume is attached to a container.", - "type": "object", - "properties": { - "name": { - "description": "Name of the volume.", - "type": "string" - }, - "readOnly": { - "description": "The flag indicating whether the volume is read only. Default is 'false'.", - "type": "boolean" - }, - "destinationPath": { - "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", - "type": "string" - } - }, - "required": [ - "name", - "destinationPath" - ] - }, - "DiagnosticsDescription": { - "description": "Describes the diagnostics options available", - "type": "object", - "properties": { - "sinks": { - "description": "List of supported sinks that can be referenced.", - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticsSinkProperties" - } - }, - "enabled": { - "description": "Status of whether or not sinks are enabled.", - "type": "boolean" - }, - "defaultSinkRefs": { - "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DiagnosticsRef": { - "description": "Reference to sinks in DiagnosticsDescription.", - "type": "object", - "properties": { - "enabled": { - "description": "Status of whether or not sinks are enabled.", - "type": "boolean" - }, - "sinkRefs": { - "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DiagnosticsSinkKind": { - "type": "string", - "description": "The kind of DiagnosticsSink.", - "enum": [ - "Invalid", - "AzureInternalMonitoringPipeline" - ], - "x-ms-enum": { - "name": "DiagnosticsSinkKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "AzureInternalMonitoringPipeline", - "description": "Diagnostics settings for Geneva." - } - ] - } - }, - "DiagnosticsSinkProperties": { - "description": "Properties of a DiagnosticsSink.", - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/DiagnosticsSinkKind", - "description": "The kind of DiagnosticsSink." - }, - "name": { - "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", - "type": "string" - }, - "description": { - "description": "A description of the sink.", - "type": "string" - } - }, - "required": [ - "kind" - ] - }, - "EndpointProperties": { - "description": "Describes a container endpoint.", - "type": "object", - "properties": { - "name": { - "description": "The name of the endpoint.", - "type": "string" - }, - "port": { - "description": "Port used by the container.", - "type": "integer" - } - }, - "required": [ - "name" - ] - }, - "EnvironmentVariable": { - "description": "Describes an environment variable for the container.", - "type": "object", - "properties": { - "name": { - "description": "The name of the environment variable.", - "type": "string" - }, - "value": { - "description": "The value of the environment variable.", - "type": "string" - } - } - }, - "ImageRegistryCredential": { - "description": "Image registry credential.", - "type": "object", - "properties": { - "server": { - "type": "string", - "description": "Docker image registry server, without protocol such as `http` and `https`." - }, - "username": { - "type": "string", - "description": "The username for the private registry." - }, - "password": { - "type": "string", - "description": "The password for the private registry." - } - }, - "required": [ - "server", - "username" - ] - }, - "NetworkRef": { - "description": "Describes a network reference in a service.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the network." - } - } - }, - "ResourceLimits": { - "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", - "type": "object", - "properties": { - "memoryInGB": { - "description": "The memory limit in GB.", - "type": "number", - "format": "double" - }, - "cpu": { - "description": "CPU limits in cores. At present, only full cores are supported.", - "type": "number", - "format": "double" - } - } - }, - "ResourceRequests": { - "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.", - "type": "object", - "properties": { - "memoryInGB": { - "description": "The memory request in GB for this container.", - "type": "number", - "format": "double" - }, - "cpu": { - "description": "Requested number of CPU cores. At present, only full cores are supported.", - "type": "number", - "format": "double" - } - }, - "required": [ - "memoryInGB", - "cpu" - ] - }, - "ResourceRequirements": { - "description": "This type describes the resource requirements for a container or a service.", - "type": "object", - "properties": { - "requests": { - "$ref": "#/definitions/ResourceRequests", - "description": "Describes the requested resources for a given container." - }, - "limits": { - "$ref": "#/definitions/ResourceLimits", - "description": "Describes the maximum limits on the resources for a given container." - } - }, - "required": [ - "requests" - ] - }, - "ServiceResourceProperties": { - "description": "This type describes properties of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceReplicaProperties" - }, - { - "type": "object", - "properties": { - "description": { - "description": "User readable description of the service.", - "type": "string" - }, - "replicaCount": { - "type": "integer", - "description": "The number of replicas of the service to create. Defaults to 1 if not specified." - }, - "healthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Represents the status of the service.", - "enum": [ - "Unknown", - "Active", - "Upgrading", - "Deleting", - "Creating", - "Failed" - ], - "x-ms-enum": { - "name": "ServiceResourceStatus", - "modelAsString": true - } - } - } - } - ] - }, - "ServiceReplicaProperties": { - "description": "Describes the properties of a service replica.", - "type": "object", - "properties": { - "osType": { - "type": "string", - "description": "The Operating system type required by the code in service.", - "enum": [ - "Linux", - "Windows" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": true - } - }, - "codePackages": { - "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerCodePackageProperties" - } - }, - "networkRefs": { - "type": "array", - "description": "The names of the private networks that this service needs to be part of.", - "items": { - "$ref": "#/definitions/NetworkRef" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsRef", - "description": "Reference to sinks in DiagnosticsDescription." - } - }, - "required": [ - "osType", - "codePackages" - ] - }, - "Setting": { - "description": "Describes a setting for the container.", - "type": "object", - "properties": { - "name": { - "description": "The name of the setting.", - "type": "string" - }, - "value": { - "description": "The value of the setting.", - "type": "string" - } - } - }, - "VolumeProperties": { - "description": "This type describes properties of a volume resource.", - "type": "object", - "properties": { - "description": { - "description": "User readable description of the volume.", - "type": "string" - }, - "provider": { - "description": "Provider of the volume.", - "type": "string", - "enum": [ - "SFAzureFile" - ], - "x-ms-enum": { - "name": "VolumeProvider", - "modelAsString": true - } - }, - "azureFileParameters": { - "$ref": "#/definitions/VolumeProviderParametersAzureFile", - "description": "This type describes a volume provided by an Azure Files file share." - } - }, - "required": [ - "provider" - ] - }, - "VolumeProviderParametersAzureFile": { - "description": "This type describes a volume provided by an Azure Files file share.", - "type": "object", - "properties": { - "accountName": { - "description": "Name of the Azure storage account for the File Share.", - "type": "string" - }, - "accountKey": { - "description": "Access key of the Azure storage account for the File Share.", - "type": "string" - }, - "shareName": { - "description": "Name of the Azure Files file share that provides storage for the volume.", - "type": "string" - } - }, - "required": [ - "accountName", - "shareName" - ] - } - }, - "parameters": { - "ApiVersion_6-0-Preview_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.0-preview" - ], - "required": true, - "default": "6.0-preview", - "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.", - "x-ms-enum": { - "name": "ApiVersion_6-0-Preview_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.0-preview", - "description": "The version number for the preview functionality of 6.0 runtime." - } - ] - } - }, - "ApiVersion_6-0_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.0" - ], - "required": true, - "default": "6.0", - "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-0_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.0", - "description": "The 6.0 version of the API." - } - ] - } - }, - "ApiVersion_6-1_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.1" - ], - "required": true, - "default": "6.1", - "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-1_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.1", - "description": "The 6.1 version of the API." - } - ] - } - }, - "ApiVersion_6-2_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.2" - ], - "required": true, - "default": "6.2", - "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-2_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.2", - "description": "The 6.2 version of the API." - } - ] - } - }, - "ApiVersion_6-2-Preview_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.2-preview" - ], - "required": true, - "default": "6.2-preview", - "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.", - "x-ms-enum": { - "name": "ApiVersion_6-2-Preview_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.2-preview", - "description": "The version number for the preview functionality of 6.2 runtime" - } - ] - } - }, - "ApiVersion_6-3_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.3" - ], - "required": true, - "default": "6.3", - "description": "The version of the API. This parameter is required and its value must be '6.3'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", - "x-ms-enum": { - "name": "ApiVersion_6-3_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.3", - "description": "The 6.3 version of the API." - } - ] - } - }, - "ApiVersion_6-3-Preview_RequiredQueryParam": { - "name": "api-version", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "6.3-preview" - ], - "required": true, - "default": "6.3-preview", - "description": "The version of the API. This parameter is required and its value must be '6.3-preview'.", - "x-ms-enum": { - "name": "ApiVersion_6-3-Preview_RequiredQueryParam", - "modelAsString": true, - "values": [ - { - "value": "6.3-preview", - "description": "The version number for the preview functionality of 6.3 runtime" - } - ] - } - }, - "ApplicationDefinitionKindFilterOptionalQueryParam": { - "name": "ApplicationDefinitionKindFilter", - "description": "Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationHealthPolicyOptionalBodyParam": { - "name": "ApplicationHealthPolicy", - "in": "body", - "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - }, - "ApplicationIdRequiredPathParam": { - "name": "applicationId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." - }, - "ApplicationsHealthStateFilterOptionalQueryParam": { - "name": "ApplicationsHealthStateFilter", - "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationTypeDefinitionKindFilterOptionalQueryParam": { - "name": "ApplicationTypeDefinitionKindFilter", - "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ApplicationTypeNameOptionalQueryParam": { - "name": "ApplicationTypeName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The application type name used to filter the applications to query for. This value should not contain the application type version." - }, - "ApplicationTypeNameRequiredPathParam": { - "name": "applicationTypeName", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of the application type." - }, - "ApplicationTypeVersionOptionalQueryParam": { - "name": "ApplicationTypeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The version of the application type." - }, - "ApplicationTypeVersionRequiredQueryParam": { - "name": "ApplicationTypeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The version of the application type." - }, - "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": { - "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam", - "in": "body", - "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" - } - }, - "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": { - "name": "ClusterConfigurationUpgradeDescription", - "in": "body", - "description": "Parameters for a standalone cluster configuration upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterConfigurationUpgradeDescription" - } - }, - "ClusterHealthPoliciesOptionalBodyParam": { - "name": "ClusterHealthPolicies", - "in": "body", - "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthPolicies" - } - }, - "ClusterHealthPolicyOptionalBodyParam": { - "name": "ClusterHealthPolicy", - "in": "body", - "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthPolicy" - } - }, - "ClusterHealthChunkQueryDescriptionOptionalBodyParam": { - "name": "ClusterHealthChunkQueryDescription", - "in": "body", - "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", - "required": false, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ClusterHealthChunkQueryDescription" - } - }, - "CodePackageInstanceIdRequiredQueryParam": { - "name": "CodePackageInstanceId", - "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "CodeVersionOptionalQueryParam": { - "name": "CodeVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The product version of Service Fabric." - }, - "ConfigVersionOptionalQueryParam": { - "name": "ConfigVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The config version of Service Fabric." - }, - "ConfigurationApiVersionRequiredQueryParam": { - "name": "ConfigurationApiVersion", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The API version of the Standalone cluster json configuration." - }, - "ContainerApiRequiredBodyParam": { - "name": "ContainerApiRequestBody", - "in": "body", - "description": "Parameters for making container API call", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ContainerApiRequestBody" - } - }, - "ContinuationTokenOptionalQueryParam": { - "name": "ContinuationToken", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." - }, - "DeployedApplicationsHealthStateFilterOptionalQueryParam": { - "name": "DeployedApplicationsHealthStateFilter", - "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeployedServicePackagesHealthStateFilterOptionalQueryParam": { - "name": "DeployedServicePackagesHealthStateFilter", - "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeploymentNameRequiredPathParam": { - "name": "deploymentName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the deployment." - }, - "EventsHealthStateFilterOptionalQueryParam": { - "name": "EventsHealthStateFilter", - "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ExcludeApplicationParametersOptionalQueryParam": { - "name": "ExcludeApplicationParameters", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "The flag that specifies whether application parameters will be excluded from the result." - }, - "HealthInformationRequiredBodyParam": { - "name": "HealthInformation", - "in": "body", - "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/HealthInformation" - } - }, - "NodeNameRequiredPathParam": { - "name": "nodeName", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of the node." - }, - "NodesHealthStateFilterOptionalQueryParam": { - "name": "NodesHealthStateFilter", - "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "NodeStatusFilterOptionalQueryParam": { - "name": "NodeStatusFilter", - "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "default", - "all", - "up", - "down", - "enabling", - "disabling", - "disabled", - "unknown", - "removed" - ], - "required": false, - "default": "default", - "x-ms-enum": { - "name": "NodeStatusFilter", - "modelAsString": true, - "values": [ - { - "value": "default", - "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." - }, - { - "value": "all", - "description": "This filter value will match all of the nodes." - }, - { - "value": "up", - "description": "This filter value will match nodes that are Up." - }, - { - "value": "down", - "description": "This filter value will match nodes that are Down." - }, - { - "value": "enabling", - "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling." - }, - { - "value": "disabling", - "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling." - }, - { - "value": "disabled", - "description": "This filter value will match nodes that are Disabled." - }, - { - "value": "unknown", - "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime." - }, - { - "value": "removed", - "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API." - } - ] - } - }, - "PartitionIdOptionalQueryParam": { - "name": "PartitionId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": false, - "description": "The identity of the partition." - }, - "PartitionIdRequiredPathParam": { - "name": "partitionId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "format": "uuid", - "required": true, - "description": "The identity of the partition." - }, - "ProvisionFabricDescriptionRequiredBodyParam": { - "name": "ProvisionFabricDescription", - "in": "body", - "description": "Describes the parameters for provisioning a cluster.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ProvisionFabricDescription" - } - }, - "UnprovisionFabricDescriptionRequiredBodyParam": { - "name": "UnprovisionFabricDescription", - "in": "body", - "description": "Describes the parameters for unprovisioning a cluster.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UnprovisionFabricDescription" - } - }, - "ResumeClusterUpgradeDescriptionRequiredBodyParam": { - "name": "ResumeClusterUpgradeDescription", - "in": "body", - "description": "Describes the parameters for resuming a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ResumeClusterUpgradeDescription" - } - }, - "UpdateClusterUpgradeDescriptionRequiredBodyParam": { - "name": "UpdateClusterUpgradeDescription", - "in": "body", - "description": "Parameters for updating a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UpdateClusterUpgradeDescription" - } - }, - "StartClusterUpgradeDescriptionRequiredBodyParam": { - "name": "StartClusterUpgradeDescription", - "in": "body", - "description": "Describes the parameters for starting a cluster upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/StartClusterUpgradeDescription" - } - }, - "ReplicaHealthReportServiceKindRequiredQueryParam": { - "name": "ReplicaHealthReportServiceKind", - "in": "query", - "required": true, - "x-ms-parameter-location": "method", - "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.", - "type": "string", - "enum": [ - "Stateless", - "Stateful" - ], - "default": "Stateful", - "x-ms-enum": { - "name": "ReplicaHealthReportServiceKind", - "modelAsString": true, - "values": [ - { - "value": "Stateless", - "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1" - }, - { - "value": "Stateful", - "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." - } - ] - } - }, - "ReplicaIdRequiredPathParam": { - "name": "replicaId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identifier of the replica." - }, - "ReplicasHealthStateFilerOptionalQueryParam": { - "name": "ReplicasHealthStateFilter", - "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "ServiceIdRequiredPathParam": { - "name": "serviceId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." - }, - "ServiceManifestNameOptionalQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." - }, - "ServiceManifestNameRequiredQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." - }, - "ServicePackageNameRequiredPathParam": { - "name": "servicePackageName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The name of the service package." - }, - "ServicesHealthStateFilterOptionalQueryParam": { - "name": "ServicesHealthStateFilter", - "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values,\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "CreateServiceFromTemplateRequiredBodyParam": { - "name": "ServiceFromTemplateDescription", - "in": "body", - "description": "Describes the service that needs to be created from the template defined in the application manifest.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceFromTemplateDescription" - } - }, - "ServiceTypeNameOptionalQueryParam": { - "name": "ServiceTypeName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The service type name used to filter the services to query for." - }, - "InfrastructureCommandRequiredQueryParam": { - "name": "Command", - "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "InfrastructureServiceIdOptionalQueryParam": { - "name": "ServiceId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.", - "required": false - }, - "ForceRemoveOptionalQueryParam": { - "name": "ForceRemove", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." - }, - "ForceRemoveReplicaOptionalQueryParam": { - "name": "ForceRemove", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." - }, - "DeactivationIntentDescriptionRequiredBodyParam": { - "name": "DeactivationIntentDescription", - "in": "body", - "description": "Describes the intent or reason for deactivating the node.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/DeactivationIntentDescription" - } - }, - "RestartNodeDescriptionRequiredBodyParam": { - "name": "RestartNodeDescription", - "in": "body", - "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestartNodeDescription" - } - }, - "ApplicationUpgradeDescriptionRequiredBodyParam": { - "name": "ApplicationUpgradeDescription", - "in": "body", - "description": "Parameters for an application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeDescription" - } - }, - "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": { - "name": "ComposeDeploymentUpgradeDescription", - "in": "body", - "description": "Parameters for upgrading compose deployment.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ComposeDeploymentUpgradeDescription" - } - }, - "ApplicationTypeImageStorePathRequiredBodyParam": { - "name": "ApplicationTypeImageStorePath", - "in": "body", - "description": "The relative path for the application package in the image store specified during the prior copy operation.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationTypeImageStorePath" - } - }, - "UnprovisionApplicationTypeRequiredBodyParam": { - "name": "UnprovisionApplicationTypeDescriptionInfo", - "in": "body", - "description": "The relative path for the application package in the image store specified during the prior copy operation.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo" - } - }, - "UpgradeOrchestrationServiceStateRequiredBodyParam": { - "name": "UpgradeOrchestrationServiceState", - "in": "body", - "x-ms-parameter-location": "method", - "required": true, - "description": "Service state of Service Fabric Upgrade Orchestration Service.", - "schema": { - "$ref": "#/definitions/UpgradeOrchestrationServiceState" - } - }, - "ChaosParametersRequiredBodyParam": { - "name": "ChaosParameters", - "in": "body", - "description": "Describes all the parameters to configure a Chaos run.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ChaosParameters" - } - }, - "StartTimeUtcOptionalQueryParam": { - "name": "StartTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." - }, - "EndTimeUtcOptionalQueryParam": { - "name": "EndTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." - }, - "ApplicationNameRequiredQueryParam": { - "name": "ApplicationName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme." - }, - "CreateComposeDeploymentRequiredBodyParam": { - "name": "CreateComposeDeploymentDescription", - "in": "body", - "description": "Describes the compose deployment that needs to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/CreateComposeDeploymentDescription" - } - }, - "PasswordEncryptedOptionalQueryParam": { - "name": "PasswordEncrypted", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "Indicates that supplied container repository password is encrypted." - }, - "RepositoryPasswordOptionalQueryParam": { - "name": "RepositoryPassword", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The password for supplied username to connect to container repository." - }, - "RepositoryUserNameOptionalQueryParam": { - "name": "RepositoryUserName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The user name to connect to container repository." - }, - "MaxResultsOptionalQueryParam": { - "name": "MaxResults", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int64", - "minimum": 0, - "default": 0, - "required": false, - "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." - }, - "ApplicationDescriptionRequiredBodyParam": { - "name": "ApplicationDescription", - "in": "body", - "description": "Description for creating an application.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationDescription" - } - }, - "ServiceDescriptionRequiredBodyParam": { - "name": "ServiceDescription", - "in": "body", - "description": "The information necessary to create a service.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - }, - "ServiceUpdateDescriptionRequiredBodyParam": { - "name": "ServiceUpdateDescription", - "in": "body", - "description": "The information necessary to update a service.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ServiceUpdateDescription" - } - }, - "ImageStoreCopyDescriptionRequiredBodyParam": { - "name": "ImageStoreCopyDescription", - "in": "body", - "description": "Describes the copy description for the image store.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ImageStoreCopyDescription" - } - }, - "CodePackageNameOptionalQueryParam": { - "name": "CodePackageName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." - }, - "CodePackageNameRequiredQueryParam": { - "name": "CodePackageName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." - }, - "RestartDeployedCodePackageRequiredBodyParam": { - "name": "RestartDeployedCodePackageDescription", - "in": "body", - "description": "Describes the deployed code package on Service Fabric node to restart.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestartDeployedCodePackageDescription" - } - }, - "PartitionsHealthStateFilterOptionalQueryParam": { - "name": "PartitionsHealthStateFilter", - "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 0 - }, - "DeployedServiceType_ServiceManifestNameOptionalQueryParam": { - "name": "ServiceManifestName", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." - }, - "ServiceTypeNameRequiredPathParam": { - "name": "serviceTypeName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Specifies the name of a Service Fabric service type." - }, - "ImageStoreContentPathRequiredPathParam": { - "name": "contentPath", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "Relative path to file or folder in the image store from its root." - }, - "PartitionKeyTypeOptionalQueryParam": { - "name": "PartitionKeyType", - "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false - }, - "PartitionKeyValueOptionalQueryParam": { - "name": "PartitionKeyValue", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named." - }, - "PreviousRspVersionOptionalQueryParam": { - "name": "PreviousRspVersion", - "in": "query", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": false, - "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale." - }, - "DataLossModeRequiredQueryParam": { - "name": "DataLossMode", - "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "PartialDataLoss", - "FullDataLoss" - ], - "required": true, - "x-ms-enum": { - "name": "DataLossMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "PartialDataLoss", - "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition." - }, - { - "value": "FullDataLoss", - "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost." - } - ] - } - }, - "FaultOperationIdRequiredQueryParam": { - "name": "OperationId", - "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": true - }, - "ForceRequiredQueryParam": { - "name": "Force", - "description": "Indicates whether to gracefully rollback and clean up internal system state modified by executing the user-induced operation.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": true, - "default": false - }, - "NodeInstanceIdRequiredQueryParam": { - "name": "NodeInstanceId", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API." - }, - "NodeTransitionTypeRequiredQueryParam": { - "name": "NodeTransitionType", - "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "Start", - "Stop" - ], - "required": true, - "x-ms-enum": { - "name": "NodeTransitionType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "Start", - "description": "Transition a stopped node to up." - }, - { - "value": "Stop", - "description": "Transition an up node to stopped." - } - ] - } - }, - "QuorumLossDurationRequiredQueryParam": { - "name": "QuorumLossDuration", - "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true - }, - "QuorumLossModeRequiredQueryParam": { - "name": "QuorumLossMode", - "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "QuorumReplicas", - "AllReplicas" - ], - "required": true, - "x-ms-enum": { - "name": "QuorumLossMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "QuorumReplicas", - "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss." - }, - { - "value": "AllReplicas" - } - ] - } - }, - "RestartPartitionModeRequiredQueryParam": { - "name": "RestartPartitionMode", - "description": "Describe which partitions to restart.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "enum": [ - "Invalid", - "AllReplicasOrInstances", - "OnlyActiveSecondaries" - ], - "required": true, - "x-ms-enum": { - "name": "RestartPartitionMode", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Reserved. Do not pass into API." - }, - { - "value": "AllReplicasOrInstances", - "description": "All replicas or instances in the partition are restarted at once." - }, - { - "value": "OnlyActiveSecondaries", - "description": "Only the secondary replicas are restarted." - } - ] - } - }, - "StateFilterRequiredQueryParam": { - "name": "StateFilter", - "description": "Used to filter on OperationState's for user-induced operations.\n\n- 65535 - select All\n- 1 - select Running\n- 2 - select RollingBack\n- 8 - select Completed\n- 16 - select Faulted\n- 32 - select Cancelled\n- 64 - select ForceCancelled", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true, - "default": 65535 - }, - "StopDurationInSecondsRequiredQueryParam": { - "name": "StopDurationInSeconds", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int32", - "minimum": 0, - "required": true, - "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up." - }, - "TypeFilterRequiredQueryParam": { - "name": "TypeFilter", - "description": "Used to filter on OperationType for user-induced operations.\n\n- 65535 - select all\n- 1 - select PartitionDataLoss.\n- 2 - select PartitionQuorumLoss.\n- 4 - select PartitionRestart.\n- 8 - select NodeTransition.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": true, - "default": 65535 - }, - "DeployServicePackageToNodeRequiredBodyParam": { - "name": "DeployServicePackageToNodeDescription", - "in": "body", - "description": "Describes information for deploying a service package to a Service Fabric node.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/DeployServicePackageToNodeDescription" - } - }, - "ResumeApplicationUpgradeDescriptionRequiredBodyParam": { - "name": "ResumeApplicationUpgradeDescription", - "in": "body", - "description": "Describes the parameters for resuming an application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ResumeApplicationUpgradeDescription" - } - }, - "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": { - "name": "ApplicationUpgradeUpdateDescription", - "in": "body", - "description": "Parameters for updating an existing application upgrade.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationUpgradeUpdateDescription" - } - }, - "TimeoutOptionalQueryParam": { - "name": "timeout", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "format": "int64", - "required": false, - "minimum": 1, - "maximum": 4294967295, - "default": 60, - "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." - }, - "NameDescriptionRequiredBodyParam": { - "name": "NameDescription", - "in": "body", - "description": "Describes the Service Fabric name to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/NameDescription" - } - }, - "NameIdRequiredPathParam": { - "name": "nameId", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The Service Fabric name, without the 'fabric:' URI scheme." - }, - "RecursiveOptionalQueryParam": { - "name": "Recursive", - "description": "Allows specifying that the search performed should be recursive.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeValuesOptionalQueryParam": { - "name": "IncludeValues", - "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "PropertyDescriptionRequiredBodyParam": { - "name": "PropertyDescription", - "in": "body", - "description": "Describes the Service Fabric property to be created.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/PropertyDescription" - } - }, - "PropertyNameRequiredQueryParam": { - "name": "PropertyName", - "description": "Specifies the name of the property to get.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true - }, - "PropertyBatchDescriptionListRequiredBodyParam": { - "name": "PropertyBatchDescriptionList", - "in": "body", - "description": "Describes the property batch operations to be submitted.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/PropertyBatchDescriptionList" - } - }, - "ImmediateOptionalQueryParam": { - "name": "Immediate", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." - }, - "ExcludeHealthStatisticsOptionalQueryParam": { - "name": "ExcludeHealthStatistics", - "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": { - "name": "IncludeSystemApplicationHealthStatistics", - "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false - }, - "IncludeHealthStateOptionalQueryParam": { - "name": "IncludeHealthState", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "default": false, - "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time." - }, - "BackupPolicyDescriptionRequiredBodyParam": { - "name": "BackupPolicyDescription", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "description": "Describes the backup policy.", - "schema": { - "$ref": "#/definitions/BackupPolicyDescription" - } - }, - "BackupPolicyNameRequiredPathParam": { - "name": "backupPolicyName", - "in": "path", - "description": "The name of the backup policy.", - "required": true, - "x-ms-parameter-location": "method", - "type": "string" - }, - "EnableBackupDescriptionRequiredBodyParam": { - "name": "EnableBackupDescription", - "in": "body", - "description": "Specifies the parameters for enabling backup.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/EnableBackupDescription" - } - }, - "RestorePartitionDescriptionRequiredBodyParam": { - "name": "RestorePartitionDescription", - "in": "body", - "description": "Describes the parameters to restore the partition.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RestorePartitionDescription" - } - }, - "RestoreTimeoutOptionalQueryParam": { - "name": "RestoreTimeout", - "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "default": 10 - }, - "BackupPartitionDescriptionOptionalBodyParam": { - "name": "BackupPartitionDescription", - "in": "body", - "required": false, - "x-ms-parameter-location": "method", - "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.", - "schema": { - "$ref": "#/definitions/BackupPartitionDescription" - } - }, - "BackupTimeoutOptionalQueryParam": { - "name": "BackupTimeout", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.", - "default": 10 - }, - "LatestOptionalQueryParam": { - "name": "Latest", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.", - "required": false, - "default": false - }, - "StartDateTimeFilterOptionalQueryParam": { - "name": "StartDateTimeFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "date-time", - "required": false, - "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." - }, - "EndDateTimeFilterOptionalQueryParam": { - "name": "EndDateTimeFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "date-time", - "required": false, - "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." - }, - "GetBackupByStorageQueryDescriptionRequiredBodyParam": { - "name": "GetBackupByStorageQueryDescription", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "description": "Describes the filters and backup storage details to be used for enumerating backups.", - "schema": { - "$ref": "#/definitions/GetBackupByStorageQueryDescription" - } - }, - "RepairTaskApproveDescriptionRequiredBodyParam": { - "name": "RepairTaskApproveDescription", - "in": "body", - "description": "Describes the repair task to be approved.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskApproveDescription" - } - }, - "RepairTaskCancelDescriptionRequiredBodyParam": { - "name": "RepairTaskCancelDescription", - "in": "body", - "description": "Describes the repair task to be cancelled.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskCancelDescription" - } - }, - "RepairTaskDeleteDescriptionRequiredBodyParam": { - "name": "RepairTaskDeleteDescription", - "in": "body", - "description": "Describes the repair task to be deleted.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTaskDeleteDescription" - } - }, - "RepairTaskExecutorFilterOptionalQueryParam": { - "name": "ExecutorFilter", - "description": "The name of the repair executor whose claimed tasks should be included in the list.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false - }, - "RepairTaskIdFilterOptionalQueryParam": { - "name": "TaskIdFilter", - "description": "The repair task ID prefix to be matched.", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false - }, - "RepairTaskRequiredBodyParam": { - "name": "RepairTask", - "in": "body", - "description": "Describes the repair task to be created or updated.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/RepairTask" - } - }, - "RepairTaskStateFilterOptionalQueryParam": { - "name": "StateFilter", - "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false - }, - "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": { - "name": "RepairTaskUpdateHealthPolicyDescription", - "in": "body", - "description": "Describes the repair task healthy policy to be updated.", - "x-ms-parameter-location": "method", - "required": true, - "schema": { - "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription" - } - }, - "UploadSessionIdRequiredQueryParam": { - "name": "session-id", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "format": "uuid", - "required": true, - "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed." - }, - "UploadFileChunkContentRangeHeaderParam": { - "name": "Content-Range", - "in": "header", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes." - }, - "TailOptionalQueryParam": { - "name": "Tail", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs." - }, - "ChaosScheduleRequiredBodyParam": { - "name": "ChaosSchedule", - "in": "body", - "description": "Describes the schedule used by Chaos.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ChaosScheduleDescription" - } - }, - "StartTimeUtcRequiredQueryParam": { - "name": "StartTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." - }, - "EndTimeUtcRequiredQueryParam": { - "name": "EndTimeUtc", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." - }, - "EventsTypesFilterOptionalQueryParam": { - "name": "EventsTypesFilter", - "in": "query", - "x-ms-parameter-location": "method", - "type": "string", - "required": false, - "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response." - }, - "ExcludeAnalysisEventsOptionalQueryParam": { - "name": "ExcludeAnalysisEvents", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "This param disables the retrieval of AnalysisEvents if true is passed." - }, - "SkipCorrelationLookupOptionalQueryParam": { - "name": "SkipCorrelationLookup", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "required": false, - "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated." - }, - "EventInstanceIdRequiredPathParam": { - "name": "eventInstanceId", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The EventInstanceId." - }, - "PreviousOptionalQueryParam": { - "name": "Previous", - "in": "query", - "x-ms-parameter-location": "method", - "type": "boolean", - "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.", - "required": false, - "default": false - }, - "ApplicationResourceNameRequiredPathParam": { - "name": "applicationResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Service Fabric application resource name." - }, - "ApplicationResourceDescriptionRequiredBodyParam": { - "name": "applicationResourceDescription", - "in": "body", - "description": "Description for creating an application resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "ReplicaNameRequiredPathParam": { - "name": "replicaName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Service Fabric replica name." - }, - "ServiceResourceNameRequiredPathParam": { - "name": "serviceResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Service Fabric service resource name." - }, - "VolumeResourceNameRequiredPathParam": { - "name": "volumeResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "Service Fabric volume resource name." - }, - "VolumeResourceDescriptionRequiredBodyParam": { - "name": "volumeResourceDescription", - "in": "body", - "description": "Description for creating a volume resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - } - } +{ + "swagger": "2.0", + "info": { + "title": "Service Fabric Client APIs", + "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.", + "version": "6.3.0.9" + }, + "host": "localhost:19080", + "schemes": [ + "http", + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/$/GetClusterManifest": { + "get": { + "operationId": "GetClusterManifest", + "summary": "Get the Service Fabric cluster manifest.", + "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster manifest information.", + "schema": { + "$ref": "#/definitions/ClusterManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealth": { + "get": { + "operationId": "GetClusterHealth", + "summary": "Gets the health of a Service Fabric cluster.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric cluster using the specified policy.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealthChunk": { + "get": { + "operationId": "GetClusterHealthChunk", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ReportClusterHealth": { + "post": { + "operationId": "ReportClusterHealth", + "summary": "Sends a health report on the Service Fabric cluster.", + "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedCodeVersions": { + "get": { + "operationId": "GetProvisionedFabricCodeVersionInfoList", + "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CodeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned code versions information.", + "schema": { + "$ref": "#/definitions/FabricCodeVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedConfigVersions": { + "get": { + "operationId": "GetProvisionedFabricConfigVersionInfoList", + "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned config versions information.", + "schema": { + "$ref": "#/definitions/FabricConfigVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeProgress": { + "get": { + "operationId": "GetClusterUpgradeProgress", + "summary": "Gets the progress of the current cluster upgrade.", + "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.", + "schema": { + "$ref": "#/definitions/ClusterUpgradeProgressObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfiguration": { + "get": { + "operationId": "GetClusterConfiguration", + "summary": "Get the Service Fabric standalone cluster configuration.", + "description": "The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration information.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfigurationUpgradeStatus": { + "get": { + "operationId": "GetClusterConfigurationUpgradeStatus", + "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.", + "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeOrchestrationServiceState": { + "get": { + "operationId": "GetUpgradeOrchestrationServiceState", + "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/SetUpgradeOrchestrationServiceState": { + "post": { + "operationId": "SetUpgradeOrchestrationServiceState", + "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Provision": { + "post": { + "summary": "Provision the code or configuration packages of a Service Fabric cluster.", + "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.", + "operationId": "ProvisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been provisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Unprovision": { + "post": { + "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.", + "description": "It is supported to unprovision code and configuration separately.", + "operationId": "UnprovisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been unprovisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RollbackUpgrade": { + "post": { + "summary": "Rollback the upgrade of a Service Fabric cluster.", + "description": "Rollback the code or configuration upgrade of a Service Fabric cluster.", + "operationId": "RollbackClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the rollback of a cluster upgrade has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Make the cluster upgrade move on to the next upgrade domain.", + "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.", + "operationId": "ResumeClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Upgrade": { + "post": { + "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.", + "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.", + "operationId": "StartClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/StartClusterConfigurationUpgrade": { + "post": { + "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.", + "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.", + "operationId": "StartClusterConfigurationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "Start upgrading the configuration of a Service Fabric standalone cluster": { + "$ref": "./examples/StartClusterConfigurationUpgrade-1.json" + } + }, + "responses": { + "202": { + "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateUpgrade": { + "post": { + "operationId": "UpdateClusterUpgrade", + "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.", + "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetAadMetadata": { + "get": { + "operationId": "GetAadMetadata", + "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.", + "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "schemes": [ + "https" + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.", + "schema": { + "$ref": "#/definitions/AadMetadataObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes": { + "get": { + "summary": "Gets the list of nodes in the Service Fabric cluster.", + "description": "The response includes the name, status, ID, health, uptime, and other details about the nodes.", + "operationId": "GetNodeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get information about all nodes": { + "$ref": "./examples/GetNodeInfoList.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetNodeInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetNodeInfoList-2.json" + } + }, + "responses": { + "200": { + "description": "List of nodes in the cluster.", + "schema": { + "$ref": "#/definitions/PagedNodeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}": { + "get": { + "summary": "Gets the information about a specific node in the Service Fabric cluster.", + "description": "The response includes the name, status, ID, health, uptime, and other details about the node.", + "operationId": "GetNodeInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get a specific node by node name": { + "$ref": "./examples/GetNodeInfo-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return information about the node with the specified nodeName.", + "schema": { + "$ref": "#/definitions/NodeInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified nodeName is not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetHealth": { + "get": { + "operationId": "GetNodeHealth", + "summary": "Gets the health of a Service Fabric node.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetNodeHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric node, by using the specified health policy.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/ReportHealth": { + "post": { + "operationId": "ReportNodeHealth", + "summary": "Sends a health report on the Service Fabric node.", + "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetLoadInformation": { + "get": { + "operationId": "GetNodeLoadInfo", + "summary": "Gets the load information of a Service Fabric node.", + "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node load information.", + "schema": { + "$ref": "#/definitions/NodeLoadInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Deactivate": { + "post": { + "operationId": "DisableNode", + "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.", + "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Activate": { + "post": { + "operationId": "EnableNode", + "summary": "Activate a Service Fabric cluster node that is currently deactivated.", + "description": "Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/RemoveNodeState": { + "post": { + "operationId": "RemoveNodeState", + "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.", + "description": "This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Restart": { + "post": { + "operationId": "RestartNode", + "summary": "Restarts a Service Fabric cluster node.", + "description": "Restarts a Service Fabric cluster node that is already started.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationTypeInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationTypeInfoList-2.json" + }, + "Exclude application parameters from the result": { + "$ref": "./examples/GetApplicationTypeInfoList-3.json" + } + }, + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoListByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/$/Provision": { + "post": { + "operationId": "ProvisionApplicationType", + "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.", + "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { + "post": { + "operationId": "UnprovisionApplicationType", + "summary": "Removes or unregisters a Service Fabric application type from the cluster.", + "description": "This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.", + "operationId": "GetServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoList-1.json" + } + }, + "responses": { + "200": { + "description": "List of service types that are supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", + "operationId": "GetServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A specific service type which supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfo" + } + }, + "204": { + "description": "A 204 response is returned if the specified service type is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { + "get": { + "summary": "Gets the manifest describing a service type.", + "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.", + "operationId": "GetServiceManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about the service type.", + "schema": { + "$ref": "#/definitions/ServiceTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.", + "operationId": "GetDeployedServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "List of information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.", + "operationId": "GetDeployedServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified service type of the application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/$/Create": { + "post": { + "summary": "Creates a Service Fabric application.", + "description": "Creates a Service Fabric application using the specified description.", + "operationId": "CreateApplication", + "x-ms-examples": { + "Create application.": { + "$ref": "./examples/CreateApplication-1.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "201": { + "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric application.", + "description": "An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.", + "operationId": "DeleteApplication", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetLoadInformation": { + "get": { + "summary": "Gets load information about a Service Fabric application.", + "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.", + "operationId": "GetApplicationLoadInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "Information about the application load.", + "schema": { + "$ref": "#/definitions/ApplicationLoadInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications": { + "get": { + "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.", + "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.", + "operationId": "GetApplicationInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationInfoList-2.json" + } + }, + "responses": { + "200": { + "description": "List of applications created in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}": { + "get": { + "summary": "Gets information about a Service Fabric application.", + "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.", + "operationId": "GetApplicationInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Get a specific application by application id": { + "$ref": "./examples/GetApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "Information about the application.", + "schema": { + "$ref": "#/definitions/ApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the service fabric application.", + "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.", + "operationId": "GetApplicationHealth", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested application health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetApplicationHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric application using the specified policy.", + "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportApplicationHealth", + "summary": "Sends a health report on the Service Fabric application.", + "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Upgrade": { + "post": { + "summary": "Starts upgrading an application in the Service Fabric cluster.", + "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.", + "operationId": "StartApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this application.", + "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.", + "operationId": "GetApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "The application upgrade details.", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/UpdateUpgrade": { + "post": { + "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.", + "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.", + "operationId": "UpdateApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Resumes upgrading an application in the Service Fabric cluster.", + "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.", + "operationId": "ResumeApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/RollbackUpgrade": { + "post": { + "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.", + "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.", + "operationId": "RollbackApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications": { + "get": { + "operationId": "GetDeployedApplicationInfoList", + "summary": "Gets the list of applications deployed on a Service Fabric node.", + "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetDeployedApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetDeployedApplicationInfoList-2.json" + }, + "Include health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoList-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed application information.", + "schema": { + "$ref": "#/definitions/PagedDeployedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}": { + "get": { + "operationId": "GetDeployedApplicationInfo", + "summary": "Gets the information about an application deployed on a Service Fabric node.", + "description": "This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get a specific deployed application by application ID and include the health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the information about the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": { + "get": { + "operationId": "GetDeployedApplicationHealth", + "summary": "Gets the information about health of an application deployed on a Service Fabric node.", + "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedApplicationHealthUsingPolicy", + "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.", + "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedApplicationHealth", + "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.", + "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { + "get": { + "summary": "Gets the manifest describing an application type.", + "description": "The response contains the application manifest XML as a string.", + "operationId": "GetApplicationManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "Information about the node.", + "schema": { + "$ref": "#/definitions/ApplicationTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices": { + "get": { + "summary": "Gets the information about all services belonging to the application specified by the application ID.", + "description": "Returns the information about all services belonging to the application specified by the application ID.", + "operationId": "GetServiceInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "List of services in the cluster for the specified application.", + "schema": { + "$ref": "#/definitions/PagedServiceInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/{serviceId}": { + "get": { + "summary": "Gets the information about the specific service belonging to the Service Fabric application.", + "description": "Returns the information about the specified service belonging to the specified Service Fabric application.", + "operationId": "GetServiceInfo", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the specified service.", + "schema": { + "$ref": "#/definitions/ServiceInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified service is not part of the specified application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetApplicationName": { + "get": { + "summary": "Gets the name of the Service Fabric application for a service.", + "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.", + "operationId": "GetApplicationNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the name of the application for the specified service.", + "schema": { + "$ref": "#/definitions/ApplicationNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/Create": { + "post": { + "operationId": "CreateService", + "summary": "Creates the specified Service Fabric service.", + "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.", + "x-ms-examples": { + "Basic stateless service": { + "$ref": "./examples/CreateService-1.json" + }, + "Basic stateful service": { + "$ref": "./examples/CreateService-2.json" + }, + "Stateless service with dns name and auto scaling": { + "$ref": "./examples/CreateService-3.json" + }, + "Stateful service with named partitions and auto scaling": { + "$ref": "./examples/CreateService-4.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": { + "post": { + "summary": "Creates a Service Fabric service from the service template.", + "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.", + "operationId": "CreateServiceFromTemplate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric service.", + "description": "A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.", + "operationId": "DeleteService", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Update": { + "post": { + "operationId": "UpdateService", + "summary": "Updates a Service Fabric service using the specified update description.", + "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.", + "x-ms-examples": { + "Stateless service": { + "$ref": "./examples/UpdateService-1.json" + }, + "Stateful service": { + "$ref": "./examples/UpdateService-2.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetDescription": { + "get": { + "summary": "Gets the description of an existing Service Fabric service.", + "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.", + "operationId": "GetServiceDescription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric service.", + "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.", + "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ReportHealth": { + "post": { + "operationId": "ReportServiceHealth", + "summary": "Sends a health report on the Service Fabric service.", + "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResolvePartition": { + "get": { + "operationId": "ResolveService", + "summary": "Resolve a Service Fabric partition.", + "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ResolvedServicePartition" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetPartitions": { + "get": { + "summary": "Gets the list of partitions of a Service Fabric service.", + "description": "The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "List of partitions of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/PagedServicePartitionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}": { + "get": { + "summary": "Gets the information about a Service Fabric partition.", + "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition.", + "schema": { + "$ref": "#/definitions/ServicePartitionInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified partitionId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetServiceName": { + "get": { + "summary": "Gets the name of the Service Fabric service for a partition.", + "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.", + "operationId": "GetServiceNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the name of the service for the specified partition.", + "schema": { + "$ref": "#/definitions/ServiceNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric partition.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.", + "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ReportHealth": { + "post": { + "operationId": "ReportPartitionHealth", + "summary": "Sends a health report on the Service Fabric partition.", + "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetLoadInformation": { + "get": { + "summary": "Gets the load information of the specified Service Fabric partition.", + "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.", + "operationId": "GetPartitionLoadInformation", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition's last reported load metrics.", + "schema": { + "$ref": "#/definitions/PartitionLoadInformation" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResetLoad": { + "post": { + "operationId": "ResetPartitionLoad", + "summary": "Resets the current load of a Service Fabric partition.", + "description": "Resets the current load of a Service Fabric partition to the default load for the service.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Recover": { + "post": { + "operationId": "RecoverPartition", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.", + "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/$/{serviceId}/$/GetPartitions/$/Recover": { + "post": { + "operationId": "RecoverServicePartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverSystemPartitions": { + "post": { + "operationId": "RecoverSystemPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverAllPartitions": { + "post": { + "operationId": "RecoverAllPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.", + "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CreateRepairTask": { + "post": { + "operationId": "CreateRepairTask", + "summary": "Creates a new repair task.", + "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CancelRepairTask": { + "post": { + "operationId": "CancelRepairTask", + "summary": "Requests the cancellation of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/DeleteRepairTask": { + "post": { + "operationId": "DeleteRepairTask", + "summary": "Deletes a completed repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetRepairTaskList": { + "get": { + "operationId": "GetRepairTaskList", + "summary": "Gets a list of repair tasks matching the given filters.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.", + "schema": { + "$ref": "#/definitions/RepairTaskList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ForceApproveRepairTask": { + "post": { + "operationId": "ForceApproveRepairTask", + "summary": "Forces the approval of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairTaskHealthPolicy": { + "post": { + "operationId": "UpdateRepairTaskHealthPolicy", + "summary": "Updates the health policy of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairExecutionState": { + "post": { + "operationId": "UpdateRepairExecutionState", + "summary": "Updates the execution state of a repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas": { + "get": { + "summary": "Gets the information about replicas of a Service Fabric service partition.", + "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the replicas of the specified partition.", + "schema": { + "$ref": "#/definitions/PagedReplicaInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { + "get": { + "summary": "Gets the information about a replica of a Service Fabric partition.", + "description": "The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the specified replicas of the specified partition of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/ReplicaInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { + "get": { + "operationId": "GetReplicaHealth", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.", + "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetReplicaHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.", + "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health information.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { + "post": { + "operationId": "ReportReplicaHealth", + "summary": "Sends a health report on the Service Fabric replica.", + "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaInfoList", + "summary": "Gets the list of replicas deployed on a Service Fabric node.", + "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfo", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": { + "post": { + "operationId": "RestartReplica", + "summary": "Restarts a service replica of a persisted service running on a node.", + "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": { + "post": { + "operationId": "RemoveReplica", + "summary": "Removes a service replica running on a node.", + "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": { + "get": { + "operationId": "GetDeployedServicePackageInfoList", + "summary": "Gets the list of service packages deployed on a Service Fabric node.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": { + "get": { + "operationId": "GetDeployedServicePackageInfoListByName", + "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified service package from the application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { + "get": { + "operationId": "GetDeployedServicePackageHealth", + "summary": "Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.", + "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedServicePackageHealthUsingPolicy", + "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.", + "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service Package" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedServicePackageHealth", + "summary": "Sends a health report on the Service Fabric deployed service package.", + "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/DeployServicePackage": { + "post": { + "operationId": "DeployServicePackageToNode", + "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.", + "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": { + "get": { + "operationId": "GetDeployedCodePackageInfoList", + "summary": "Gets the list of code packages deployed on a Service Fabric node.", + "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed code packages information.", + "schema": { + "$ref": "#/definitions/DeployedCodePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": { + "post": { + "operationId": "RestartDeployedCodePackage", + "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.", + "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": { + "get": { + "operationId": "GetContainerLogsDeployedOnNode", + "summary": "Gets the container logs for container deployed on a Service Fabric node.", + "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get container logs for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json" + }, + "Get last 10 lines of container logs": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json" + }, + "Get container logs of previous dead container for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": { + "post": { + "operationId": "InvokeContainerApi", + "summary": "Invoke container API on a container deployed on a Service Fabric node.", + "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.", + "x-ms-examples": { + "Get container logs": { + "$ref": "./examples/InvokeContainerApi.json" + }, + "Update container": { + "$ref": "./examples/InvokeContainerApi_Post.json" + } + }, + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContainerApiRequiredBodyParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerApiResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/$/Create": { + "put": { + "summary": "Creates a Service Fabric compose deployment.", + "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.", + "operationId": "CreateComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}": { + "get": { + "summary": "Gets information about a Service Fabric compose deployment.", + "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.", + "operationId": "GetComposeDeploymentStatus", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Information about the compose deployment.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments": { + "get": { + "summary": "Gets the list of compose deployments created in the Service Fabric cluster.", + "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.", + "operationId": "GetComposeDeploymentStatusList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "List of status of compose deployments in the cluster.", + "schema": { + "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.", + "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.", + "operationId": "GetComposeDeploymentUpgradeProgress", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Details about the compose deployment upgrade.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric compose deployment from cluster.", + "description": "Deletes an existing Service Fabric compose deployment.", + "operationId": "RemoveComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Upgrade": { + "post": { + "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.", + "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.", + "operationId": "StartComposeDeploymentUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos": { + "get": { + "operationId": "GetChaos", + "summary": "Get the status of Chaos.", + "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the status of Chaos.", + "schema": { + "$ref": "#/definitions/Chaos" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Start": { + "post": { + "operationId": "StartChaos", + "summary": "Starts Chaos in the cluster.", + "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nRefer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ChaosParametersRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Stop": { + "post": { + "operationId": "StopChaos", + "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.", + "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Events": { + "get": { + "operationId": "GetChaosEvents", + "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.", + "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.", + "x-ms-examples": { + "Get Chaos events given a time range": { + "$ref": "./examples/GetChaosEvents.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "Next segment of Chaos events.", + "schema": { + "$ref": "#/definitions/ChaosEventsSegment" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Schedule": { + "get": { + "operationId": "GetChaosSchedule", + "summary": "Get the Chaos Schedule defining when and how to run Chaos.", + "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "PostChaosSchedule", + "summary": "Set the schedule used by Chaos.", + "description": "Chaos will automatically schedule runs based on the Chaos Schedule.\nThe Chaos Schedule will be updated if the provided version matches the version on the server.\nWhen updating the Chaos Schedule, the version on the server is incremented by 1.\nThe version on the server will wrap back to 0 after reaching a large number.\nIf Chaos is running when this call is made, the call will fail.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ChaosScheduleRequiredBodyParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}": { + "put": { + "summary": "Uploads contents of the file to the image store.", + "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.", + "operationId": "UploadFile", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the image store content information.", + "description": "Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.", + "operationId": "GetImageStoreContent", + "x-ms-examples": { + "Get information about image store content under a given relative path": { + "$ref": "./examples/GetImageStoreContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes existing image store content.", + "description": "Deletes existing image store content being found within the given image store relative path. This can be used to delete uploaded application packages once they are provisioned.", + "operationId": "DeleteImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore": { + "get": { + "summary": "Gets the content information at the root of the image store.", + "description": "Returns the information about the image store content at the root of the image store.", + "operationId": "GetImageStoreRootContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/Copy": { + "post": { + "summary": "Copies image store content internally", + "description": "Copies the image store content from the source image store relative path to the destination image store relative path.", + "operationId": "CopyImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/DeleteUploadSession": { + "delete": { + "summary": "Cancels an image store upload session.", + "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.", + "operationId": "DeleteImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/CommitUploadSession": { + "post": { + "summary": "Commit an image store upload session.", + "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ", + "operationId": "CommitImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by ID.", + "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionById", + "x-ms-examples": { + "Get information about image store upload session by a given ID": { + "$ref": "./examples/GetUploadSessionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by relative path.", + "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionByPath", + "x-ms-examples": { + "Get information about image store upload session by a given relative path": { + "$ref": "./examples/GetUploadSessionByPath.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/UploadChunk": { + "put": { + "summary": "Uploads a file chunk to the image store relative path.", + "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.", + "operationId": "UploadFileChunk", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureCommand": { + "post": { + "operationId": "InvokeInfrastructureCommand", + "summary": "Invokes an administrative command on the given Infrastructure Service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureQuery": { + "get": { + "operationId": "InvokeInfrastructureQuery", + "summary": "Invokes a read-only query on the given infrastructure service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": { + "post": { + "operationId": "StartDataLoss", + "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.", + "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode.\n\n- PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\n- FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/DataLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": { + "get": { + "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.", + "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.", + "operationId": "GetDataLossProgress", + "x-ms-examples": { + "Gets information about a partition data loss operation. In this case the operation has a State of Completed": { + "$ref": "./examples/GetDataLossProgress.json" + }, + "Get information about a partition data loss operation. In this case the operation is a State of Running": { + "$ref": "./examples/GetDataLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of the partition data loss operation.", + "schema": { + "$ref": "#/definitions/PartitionDataLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": { + "post": { + "operationId": "StartQuorumLoss", + "summary": "Induces quorum loss for a given stateful service partition.", + "description": "This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": { + "get": { + "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.", + "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.", + "operationId": "GetQuorumLossProgress", + "x-ms-examples": { + "Gets information about a completed quorum loss operation": { + "$ref": "./examples/GetQuorumLossProgress.json" + }, + "Gets information about a running quorum operation operation": { + "$ref": "./examples/GetQuorumLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition quorum loss operation.", + "schema": { + "$ref": "#/definitions/PartitionQuorumLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": { + "post": { + "operationId": "StartPartitionRestart", + "summary": "This API will restart some or all replicas or instances of the specified partition.", + "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": { + "get": { + "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.", + "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.", + "operationId": "GetPartitionRestartProgress", + "x-ms-examples": { + "Get information a completed PartitionRestart operation": { + "$ref": "./examples/GetPartitionRestartProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition restart operation.", + "schema": { + "$ref": "#/definitions/PartitionRestartProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/StartTransition/": { + "post": { + "operationId": "StartNodeTransition", + "summary": "Starts or stops a cluster node.", + "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": { + "get": { + "summary": "Gets the progress of an operation started using StartNodeTransition.", + "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.", + "operationId": "GetNodeTransitionProgress", + "x-ms-examples": { + "Gets information about a completed NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress.json" + }, + "Gets information about a running NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a node transition operation.", + "schema": { + "$ref": "#/definitions/NodeTransitionProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/": { + "get": { + "operationId": "GetFaultOperationList", + "summary": "Gets a list of user-induced fault operations filtered by provided input.", + "description": "Gets the a list of user-induced fault operations filtered by provided input.", + "x-ms-examples": { + "Gets information on fault operations": { + "$ref": "./examples/GetFaultOperationList.json" + } + }, + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TypeFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/StateFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/OperationStatusList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/$/Cancel": { + "post": { + "operationId": "CancelOperation", + "summary": "Cancels a user-induced fault operation.", + "description": "The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/ForceRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/$/Create": { + "post": { + "operationId": "CreateBackupPolicy", + "summary": "Creates a backup policy.", + "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.", + "x-ms-examples": { + "Create a time based backup policy with Azure as backup location": { + "$ref": "./examples/CreateBackupPolicy-1.json" + }, + "Create a frequency based backup policy with file share as backup location": { + "$ref": "./examples/CreateBackupPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "201": { + "description": "A sucessful operation returns 201 status code and creates a new backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": { + "post": { + "operationId": "DeleteBackupPolicy", + "summary": "Deletes the backup policy.", + "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.", + "x-ms-examples": { + "Delete backup policy": { + "$ref": "./examples/DeleteBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and deletes the backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies": { + "get": { + "operationId": "GetBackupPolicyList", + "summary": "Gets all the backup policies configured.", + "description": "Get a list of all the backup policies configured.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupPolicyList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupPolicyList-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and paged list of backup policies.", + "schema": { + "$ref": "#/definitions/PagedBackupPolicyDescriptionList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}": { + "get": { + "operationId": "GetBackupPolicyByName", + "summary": "Gets a particular backup policy by name.", + "description": "Gets a particular backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Get backup policy by name": { + "$ref": "./examples/GetBackupPolicyByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the backup policy description.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": { + "get": { + "operationId": "GetAllEntitiesBackedUpByPolicy", + "summary": "Gets the list of backup entities that are associated with this policy.", + "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.", + "schema": { + "$ref": "#/definitions/PagedBackupEntityList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": { + "post": { + "operationId": "UpdateBackupPolicy", + "summary": "Updates the backup policy.", + "description": "Updates the backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Update backup policy": { + "$ref": "./examples/UpdateBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A sucessful operation resturns 200 status code and updates the backup policy description." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/EnableBackup": { + "post": { + "operationId": "EnableApplicationBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable application backup": { + "$ref": "./examples/EnableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/DisableBackup": { + "post": { + "operationId": "DisableApplicationBackup", + "summary": "Disables periodic backup of Service Fabric application.", + "description": "Disables periodic backup of Service Fabric application which was previously enabled.", + "x-ms-examples": { + "Disable application backup": { + "$ref": "./examples/DisableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetApplicationBackupConfigurationInfo", + "summary": "Gets the Service Fabric application backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackups": { + "get": { + "operationId": "GetApplicationBackupList", + "summary": "Gets the list of backups available for every partition in this application.", + "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetApplicationBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetApplicationBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendApplicationBackup", + "summary": "Suspends periodic backup for the specified Service Fabric application.", + "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.", + "x-ms-examples": { + "Suspend application backup": { + "$ref": "./examples/SuspendApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeApplicationBackup", + "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.", + "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume application backup": { + "$ref": "./examples/ResumeApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/EnableBackup": { + "post": { + "operationId": "EnableServiceBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable service backup": { + "$ref": "./examples/EnableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/DisableBackup": { + "post": { + "operationId": "DisableServiceBackup", + "summary": "Disables periodic backup of Service Fabric service which was previously enabled.", + "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.", + "x-ms-examples": { + "Disable service backup": { + "$ref": "./examples/DisableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetServiceBackupConfigurationInfo", + "summary": "Gets the Service Fabric service backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackups": { + "get": { + "operationId": "GetServiceBackupList", + "summary": "Gets the list of backups available for every partition in this service.", + "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetServiceBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetServiceBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendServiceBackup", + "summary": "Suspends periodic backup for the specified Service Fabric service.", + "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.", + "x-ms-examples": { + "Suspend service backup": { + "$ref": "./examples/SuspendServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeServiceBackup", + "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.", + "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume service backup": { + "$ref": "./examples/ResumeServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/EnableBackup": { + "post": { + "operationId": "EnablePartitionBackup", + "summary": "Enables periodic backup of the stateful persisted partition.", + "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable partition backup": { + "$ref": "./examples/EnablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/DisableBackup": { + "post": { + "operationId": "DisablePartitionBackup", + "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.", + "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.", + "x-ms-examples": { + "Disable partition backup": { + "$ref": "./examples/DisablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetPartitionBackupConfigurationInfo", + "summary": "Gets the partition backup configuration information", + "description": "Gets the Service Fabric Backup configuration information for the specified partition.", + "x-ms-examples": { + "Get partition backup configuration information": { + "$ref": "./examples/GetPartitionBackupConfigurationInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.", + "schema": { + "$ref": "#/definitions/PartitionBackupConfigurationInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackups": { + "get": { + "operationId": "GetPartitionBackupList", + "summary": "Gets the list of backups available for the specified partition.", + "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetPartitionBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetPartitionBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetPartitionBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetPartitionBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendPartitionBackup", + "summary": "Suspends periodic backup for the specified partition.", + "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.", + "x-ms-examples": { + "Suspend partition backup": { + "$ref": "./examples/SuspendPartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResumeBackup": { + "post": { + "operationId": "ResumePartitionBackup", + "summary": "Resumes periodic backup of partition which was previously suspended.", + "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume partition backup": { + "$ref": "./examples/ResumePartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Backup": { + "post": { + "operationId": "BackupPartition", + "summary": "Triggers backup of the partition's state.", + "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.", + "x-ms-examples": { + "Backup partition": { + "$ref": "./examples/BackupPartition-1.json" + }, + "Backup partition to a specific Azure storage account": { + "$ref": "./examples/BackupPartition-2.json" + }, + "Backup partition to a specific on-premise file share": { + "$ref": "./examples/BackupPartition-3.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/BackupTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupProgress": { + "get": { + "operationId": "GetPartitionBackupProgress", + "summary": "Gets details for the latest backup triggered for this partition.", + "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get backup operation progress": { + "$ref": "./examples/GetPartitionBackupProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and backup progress details.", + "schema": { + "$ref": "#/definitions/BackupProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Restore": { + "post": { + "operationId": "RestorePartition", + "summary": "Triggers restore of the state of the partition using the specified restore partition description.", + "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.", + "x-ms-examples": { + "Trigger partition restore": { + "$ref": "./examples/RestorePartition.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetRestoreProgress": { + "get": { + "operationId": "GetPartitionRestoreProgress", + "summary": "Gets details for the latest restore operation triggered for this partition.", + "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get restore operation progress": { + "$ref": "./examples/GetPartitionRestoreProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and restore progress details.", + "schema": { + "$ref": "#/definitions/RestoreProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/$/GetBackups": { + "post": { + "operationId": "GetBackupsFromBackupLocation", + "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.", + "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupsFromBackupLocation-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupsFromBackupLocation-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/$/Create": { + "post": { + "summary": "Creates a Service Fabric name.", + "description": "Creates the specified Service Fabric name.", + "operationId": "CreateName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Create new name": { + "$ref": "examples/CreateName-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "201": { + "description": "A successful response means that the name has been created." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}": { + "get": { + "summary": "Returns whether the Service Fabric name exists.", + "description": "Returns whether the specified Service Fabric name exists.", + "operationId": "GetNameExistsInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name exists." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes a Service Fabric name.", + "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.", + "operationId": "DeleteName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetSubNames": { + "get": { + "summary": "Enumerates all the Service Fabric names under a given name.", + "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.", + "operationId": "GetSubNameInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RecursiveOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get sub names": { + "$ref": "examples/GetSubNameInfoList-1.json" + }, + "Recursively search sub names": { + "$ref": "examples/GetSubNameInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetSubNameInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric names.", + "schema": { + "$ref": "#/definitions/PagedSubNameInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties": { + "get": { + "summary": "Gets information on all Service Fabric properties under a given name.", + "description": "A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.", + "operationId": "GetPropertyInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/IncludeValuesOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info list": { + "$ref": "examples/GetPropertyInfoList-1.json" + }, + "Get property info list with values": { + "$ref": "examples/GetPropertyInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetPropertyInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric properties.", + "schema": { + "$ref": "#/definitions/PagedPropertyInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperty": { + "put": { + "summary": "Creates or updates a Service Fabric property.", + "description": "Creates or updates the specified Service Fabric property under a given name.", + "operationId": "PutProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Put property": { + "$ref": "examples/PutProperty-1.json" + }, + "Put custom property": { + "$ref": "examples/PutProperty-2.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been created or updated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the specified Service Fabric property.", + "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.", + "operationId": "GetPropertyInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info": { + "$ref": "examples/GetPropertyInfo-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "Details on the Service Fabric property.", + "schema": { + "$ref": "#/definitions/PropertyInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes the specified Service Fabric property.", + "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.", + "operationId": "DeleteProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties/$/SubmitBatch": { + "post": { + "summary": "Submits a property batch.", + "description": "Submits a batch of property operations. Either all or none of the operations will be committed.", + "operationId": "SubmitPropertyBatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Property batch operation": { + "$ref": "examples/SubmitPropertyBatch-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property batch succeeded.", + "schema": { + "$ref": "#/definitions/SuccessfulPropertyBatchInfo" + } + }, + "409": { + "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", + "schema": { + "$ref": "#/definitions/FailedPropertyBatchInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Cluster/Events": { + "get": { + "summary": "Gets all Cluster-related events.", + "description": "The response is list of ClusterEvent objects.", + "operationId": "GetClusterEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Cluster-related events": { + "$ref": "./examples/GetClusterEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ClusterEvent.", + "schema": { + "$ref": "#/definitions/ClusterEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Containers/Events": { + "get": { + "summary": "Gets all Containers-related events.", + "description": "The response is list of ContainerInstanceEvent objects.", + "operationId": "GetContainersEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "responses": { + "200": { + "description": "List of events objects with base type ContainerInstanceEvent.", + "schema": { + "$ref": "#/definitions/ContainerInstanceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/{nodeName}/$/Events": { + "get": { + "summary": "Gets a Node-related events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodeEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Node-related events": { + "$ref": "./examples/GetNodeEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/Events": { + "get": { + "summary": "Gets all Nodes-related Events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Nodes-related events": { + "$ref": "./examples/GetNodesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/{applicationId}/$/Events": { + "get": { + "summary": "Gets an Application-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Application-related events": { + "$ref": "./examples/GetApplicationEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/Events": { + "get": { + "summary": "Gets all Applications-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Applications-related events": { + "$ref": "./examples/GetApplicationsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/{serviceId}/$/Events": { + "get": { + "summary": "Gets a Service-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServiceEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Service-related events": { + "$ref": "./examples/GetServiceEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/Events": { + "get": { + "summary": "Gets all Services-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServicesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Services-related events": { + "$ref": "./examples/GetServicesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Events": { + "get": { + "summary": "Gets a Partition-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition-related events": { + "$ref": "./examples/GetPartitionEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/Events": { + "get": { + "summary": "Gets all Partitions-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partitions-related events": { + "$ref": "./examples/GetPartitionsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": { + "get": { + "summary": "Gets a Partition Replica-related events.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicaEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replica-related events": { + "$ref": "./examples/GetReplicaEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": { + "get": { + "summary": "Gets all Replicas-related events for a Partition.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicasEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replicas-related events": { + "$ref": "./examples/GetReplicasEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": { + "get": { + "summary": "Gets all correlated events for a given event.", + "description": "The response is list of FabricEvents.", + "operationId": "GetCorrelatedEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventInstanceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Correlated events": { + "$ref": "./examples/GetCorrelatedEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type FabricEvent.", + "schema": { + "$ref": "#/definitions/EventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}": { + "put": { + "operationId": "CreateApplicationResource", + "x-ms-examples": { + "CreateOrUpdateApplicationResource": { + "$ref": "./examples/Resource/CreateOrUpdateApplicationResource.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application with the specified name and description. If an application with the same name already exists, then its description are updated to the one indicated in this request.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "201": { + "description": "Created" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "GetApplicationResource", + "x-ms-examples": { + "GetApplicationResource": { + "$ref": "./examples/Resource/GetApplicationResource.json" + } + }, + "summary": "Gets the application with the given name.", + "description": "Gets the application with the given name. This includes the information about the application's services and other runtime information.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "DeleteApplicationResource", + "x-ms-examples": { + "DeleteApplicationResource": { + "$ref": "./examples/Resource/DeleteApplicationResource.json" + } + }, + "summary": "Deletes the specified application.", + "description": "Deletes the application identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services": { + "get": { + "operationId": "GetServices", + "x-ms-examples": { + "GetServices": { + "$ref": "./examples/Resource/GetServices.json" + } + }, + "summary": "Gets all the services in the application resource.", + "description": "The operation returns the service descriptions of all the services in the application resource. ", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedServiceResourceDescriptionList" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}": { + "get": { + "operationId": "GetService", + "x-ms-examples": { + "GetService": { + "$ref": "./examples/Resource/GetService.json" + } + }, + "summary": "Gets the description of the specified service in an application resource.", + "description": "Gets the description of the service resource.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/replicas": { + "get": { + "operationId": "GetReplicas", + "x-ms-examples": { + "GetReplicas": { + "$ref": "./examples/Resource/GetReplicas.json" + } + }, + "summary": "Gets replicas of a given service in an applciation resource.", + "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedServiceResourceReplicaDescriptionList" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}": { + "get": { + "operationId": "GetReplica", + "x-ms-examples": { + "GetReplica": { + "$ref": "./examples/Resource/GetReplica.json" + } + }, + "summary": "Gets a specific replica of a given service in an application resource.", + "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "ApplicationResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceReplicaDescription" + } + } + } + } + }, + "/Resources/Volumes/{volumeResourceName}": { + "put": { + "operationId": "CreateVolumeResource", + "x-ms-examples": { + "CreateOrUpdateVolumeResource": { + "$ref": "./examples/Resource/CreateOrUpdateVolumeResource.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "VolumeResource" + ], + "responses": { + "201": { + "description": "Created" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "GetVolumeResource", + "x-ms-examples": { + "GetVolumeResource": { + "$ref": "./examples/Resource/GetVolumeResource.json" + } + }, + "summary": "Gets the volume resource.", + "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "VolumeResource" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "DeleteVolumeResource", + "x-ms-examples": { + "DeleteVolumeResource": { + "$ref": "./examples/Resource/DeleteVolumeResource.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "VolumeResource" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + } + }, + "definitions": { + "AadMetadata": { + "type": "object", + "description": "Azure Active Directory metadata used for secured connection to cluster.", + "properties": { + "authority": { + "type": "string", + "description": "The AAD authority url." + }, + "client": { + "type": "string", + "description": "The AAD client application Id." + }, + "cluster": { + "type": "string", + "description": "The AAD cluster application Id." + }, + "login": { + "type": "string", + "description": "The AAD login url." + }, + "redirect": { + "type": "string", + "description": "The client application redirect address." + }, + "tenant": { + "type": "string", + "description": "The AAD tenant Id." + } + } + }, + "AadMetadataObject": { + "type": "object", + "description": "Azure Active Directory metadata object used for secured connection to cluster.", + "properties": { + "type": { + "type": "string", + "description": "The client authentication method." + }, + "metadata": { + "$ref": "#/definitions/AadMetadata", + "description": "Azure Active Directory metadata used for secured connection to cluster." + } + } + }, + "AnalysisEventMetadata": { + "type": "object", + "description": "Metadata about an Analysis Event.", + "properties": { + "Delay": { + "type": "string", + "format": "duration", + "description": "The analysis delay." + }, + "Duration": { + "type": "string", + "format": "duration", + "description": "The duration of analysis." + } + } + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application.", + "enum": [ + "Invalid", + "ServiceFabricApplicationDescription", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535." + }, + { + "value": "ServiceFabricApplicationDescription", + "description": "Indicates the application is defined by a Service Fabric application description. The value is 0." + }, + { + "value": "Compose", + "description": "Indicates the application is defined by compose file(s). The value is 1." + } + ] + } + }, + "ApplicationEvent": { + "description": "Represents the base for all Application Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ApplicationEvent", + "properties": { + "ApplicationId": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + } + }, + "required": [ + "ApplicationId" + ] + } + ], + "x-ms-discriminator-value": "ApplicationEvent" + }, + "ApplicationEventList": { + "description": "A list of ApplicationEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationEvent" + } + }, + "ApplicationHealth": { + "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ApplicationHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthState" + }, + "description": "Service health states as found in the health store." + }, + "DeployedApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthState" + }, + "description": "Deployed application health states as found in the health store." + } + } + } + ] + }, + "ApplicationHealthEvaluation": { + "x-ms-discriminator-value": "Application", + "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationHealthEvaluation", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "ApplicationHealthPolicies": { + "type": "object", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.", + "default": 0 + }, + "DefaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "ServiceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthPolicyMapItem" + }, + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ApplicationHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ApplicationHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "$ref": "#/definitions/ApplicationName", + "description": "The key of the application health policy map item. This is the name of the application." + }, + "Value": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application." + } + } + }, + "ApplicationHealthState": { + "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ApplicationHealthState", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ] + }, + "ApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunk", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ServiceHealthStateChunks": { + "$ref": "#/definitions/ServiceHealthStateChunkList", + "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "DeployedApplicationHealthStateChunks": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunkList", + "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "ApplicationHealthStateChunkList": { + "type": "object", + "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + }, + { + "type": "object", + "description": "ApplicationHealthStateChunkList", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateChunk" + }, + "description": "The list of application health state chunks that respect the input filters in the chunk query." + } + } + } + ] + }, + "ApplicationHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.", + "properties": { + "ApplicationNameFilter": { + "type": "string", + "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "ApplicationTypeNameFilter": { + "type": "string", + "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ServiceFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateFilter" + }, + "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name." + }, + "DeployedApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node." + } + } + }, + "ApplicationId": { + "type": "string", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationInfo": { + "type": "object", + "description": "Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/ApplicationStatus", + "description": "The status of the application." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ApplicationDefinitionKind": { + "$ref": "#/definitions/ApplicationDefinitionKind", + "description": "The mechanism used to define a Service Fabric application." + } + } + }, + "ApplicationLoadInfo": { + "type": "object", + "description": "Load Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero." + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero." + }, + "NodeCount": { + "type": "integer", + "format": "int64", + "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero." + }, + "ApplicationLoadMetricInformation": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationName": { + "type": "string", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationNameInfo": { + "type": "object", + "description": "Information about the application name.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + }, + "ApplicationPackageCleanupPolicy": { + "type": "string", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.", + "enum": [ + "Invalid", + "Default", + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "ApplicationPackageCleanupPolicy", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero." + }, + { + "value": "Default", + "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1." + }, + { + "value": "Automatic", + "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2." + }, + { + "value": "Manual", + "description": "Indicates that the user has to explicitly clean up the application package. The value is 3." + } + ] + } + }, + "ApplicationParameter": { + "type": "object", + "description": "Describes an application parameter override to be applied when creating or upgrading an application.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The name of the parameter." + }, + "Value": { + "type": "string", + "description": "The value of the parameter." + } + } + }, + "ApplicationParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "Applications", + "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ApplicationStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the application status is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the application status is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the application status is creating. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the application status is deleting. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5." + } + ] + } + }, + "ApplicationTypeApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "ApplicationTypeApplications", + "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ApplicationTypeApplicationsHealthEvaluation", + "properties": { + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications of the application type found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health." + } + } + } + ] + }, + "ApplicationTypeDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application type.", + "enum": [ + "Invalid", + "ServiceFabricApplicationPackage", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationTypeDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0." + }, + { + "value": "ServiceFabricApplicationPackage", + "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1." + }, + { + "value": "Compose", + "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2." + } + ] + } + }, + "ApplicationTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem" + }, + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + }, + "ApplicationTypeHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ApplicationTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the application type health policy map item. This is the name of the application type." + }, + "Value": { + "type": "integer", + "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100." + } + } + }, + "ApplicationTypeInfo": { + "type": "object", + "description": "Information about an application type.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Version": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "DefaultParameterList": { + "$ref": "#/definitions/ApplicationTypeParameterList", + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "Status": { + "$ref": "#/definitions/ApplicationTypeStatus", + "description": "The status of the application type." + }, + "StatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the application type." + }, + "ApplicationTypeDefinitionKind": { + "$ref": "#/definitions/ApplicationTypeDefinitionKind", + "description": "The mechanism used to define a Service Fabric application type." + } + } + }, + "PagedApplicationTypeInfoList": { + "type": "object", + "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application type information.", + "items": { + "$ref": "#/definitions/ApplicationTypeInfo" + } + } + } + }, + "ApplicationTypeManifest": { + "type": "object", + "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "ApplicationTypeStatus": { + "type": "string", + "description": "The status of the application type.", + "enum": [ + "Invalid", + "Provisioning", + "Available", + "Unprovisioning", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationTypeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the application type is being provisioned in the cluster. The value is 1." + }, + { + "value": "Available", + "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3." + }, + { + "value": "Failed", + "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4." + } + ] + } + }, + "ApplicationUnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "ApplicationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "Name", + "TargetApplicationTypeVersion", + "UpgradeKind", + "Parameters" + ] + }, + "ApplicationUpgradeProgressInfo": { + "type": "object", + "description": "Describes the parameters for an application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ApplicationUpgradeDescription", + "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription." + }, + "UpgradeDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + } + } + }, + "ByteArray": { + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.", + "type": "array", + "items": { + "type": "integer" + } + }, + "ClusterConfiguration": { + "type": "object", + "description": "Information about the standalone cluster configuration.", + "properties": { + "ClusterConfiguration": { + "type": "string", + "description": "The contents of the cluster configuration file." + } + } + }, + "ClusterEvent": { + "description": "Represents the base for all Cluster Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ClusterEvent" + } + ], + "x-ms-discriminator-value": "ClusterEvent" + }, + "ClusterEventList": { + "description": "A list of ClusterEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterEvent" + } + }, + "ClusterHealth": { + "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ClusterHealth", + "properties": { + "NodeHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthState" + }, + "description": "Cluster node health states as found in the health store." + }, + "ApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthState" + }, + "description": "Cluster application health states as found in the health store." + } + } + } + ] + }, + "ClusterHealthChunk": { + "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.", + "type": "object", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies." + }, + "NodeHealthStateChunks": { + "$ref": "#/definitions/NodeHealthStateChunkList", + "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "ApplicationHealthStateChunks": { + "$ref": "#/definitions/ApplicationHealthStateChunkList", + "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + }, + "ClusterHealthChunkQueryDescription": { + "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.", + "properties": { + "NodeFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateFilter" + }, + "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName." + }, + "ApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ApplicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "ClusterHealthPolicies": { + "description": "Health policies to evaluate cluster health.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + } + } + }, + "ClusterHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.", + "default": 0 + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.", + "default": 0 + }, + "ApplicationTypeHealthPolicyMap": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMap", + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + } + } + }, + "ClusterManifest": { + "type": "object", + "description": "Information about the cluster manifest.", + "properties": { + "Manifest": { + "type": "string", + "description": "The contents of the cluster manifest file." + } + } + }, + "ContainerApiRequestBody": { + "type": "object", + "description": "parameters for making container API call.", + "properties": { + "HttpVerb": { + "type": "string", + "description": "HTTP verb of container REST API, defaults to \"GET\"" + }, + "UriPath": { + "type": "string", + "description": "URI path of container REST API" + }, + "Content-Type": { + "type": "string", + "description": "Content type of container REST API request, defaults to \"application/json\"" + }, + "Body": { + "type": "string", + "description": "HTTP request body of container REST API" + } + }, + "required": [ + "UriPath" + ] + }, + "ContainerApiResponse": { + "type": "object", + "description": "Response body that wraps container API result.", + "properties": { + "ContainerApiResult": { + "$ref": "#/definitions/ContainerApiResult", + "description": "Container API result." + } + }, + "required": [ + "ContainerApiResult" + ] + }, + "ContainerApiResult": { + "type": "object", + "description": "Container API result.", + "properties": { + "Status": { + "type": "integer", + "description": "HTTP status code returned by the target container API" + }, + "Content-Type": { + "type": "string", + "description": "HTTP content type" + }, + "Content-Encoding": { + "type": "string", + "description": "HTTP content encoding" + }, + "Body": { + "type": "string", + "description": "container API result body" + } + }, + "required": [ + "Status" + ] + }, + "ContainerInstanceEvent": { + "description": "Represents the base for all Container Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ContainerInstanceEvent" + } + ], + "x-ms-discriminator-value": "ContainerInstanceEvent" + }, + "ContainerInstanceEventList": { + "description": "A list of ContainerInstanceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerInstanceEvent" + } + }, + "ContinuationToken": { + "type": "string", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "CurrentUpgradeDomainProgressInfo": { + "type": "object", + "description": "Information about the current in-progress upgrade domain.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "CurrentUpgradeDomainDuration": { + "type": "string", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "DeactivationIntentDescription": { + "description": "Describes the intent or reason for deactivating the node.", + "properties": { + "DeactivationIntent": { + "type": "string", + "description": "Describes the intent or reason for deactivating the node. The possible values are following.", + "enum": [ + "Pause", + "Restart", + "RemoveData" + ], + "x-ms-enum": { + "name": "DeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates the intent is for the node to remove data. The value is 3." + } + ] + } + } + } + }, + "DeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "DeltaNodesCheck", + "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeltaNodesCheckHealthEvaluation", + "properties": { + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedApplicationHealth": { + "description": "Information about the health of an application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "DeployedApplicationHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "Name of the application deployed on the node whose health information is described by this object." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this application is deployed." + }, + "DeployedServicePackageHealthStates": { + "$ref": "#/definitions/DeployedServicePackageHealthStateList", + "description": "Deployed service package health states for the current deployed application as found in the health store." + } + } + } + ] + }, + "DeployedApplicationHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplication", + "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedApplicationHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where the application is deployed to." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "DeployedApplicationHealthState": { + "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "DeployedApplicationHealthState", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ] + }, + "DeployedApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "DeployedApplicationHealthStateChunk", + "properties": { + "NodeName": { + "type": "string", + "description": "The name of node where the application is deployed." + }, + "DeployedServicePackageHealthStateChunks": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList", + "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "DeployedApplicationHealthStateChunkList": { + "type": "object", + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunk" + }, + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedApplicationHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "DeployedServicePackageFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node." + } + } + }, + "DeployedApplicationInfo": { + "type": "object", + "description": "Information about application deployed on the node.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/DeployedApplicationStatus", + "description": "The status of the application deployed on the node. Following are the possible values." + }, + "WorkDirectory": { + "type": "string", + "description": "The work directory of the application on the node. The work directory can be used to store application data." + }, + "LogDirectory": { + "type": "string", + "description": "The log directory of the application on the node. The log directory can be used to store application logs." + }, + "TempDirectory": { + "type": "string", + "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "DeployedApplicationInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + }, + "description": "List of deployed application information." + }, + "DeployedApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplications", + "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedApplicationsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed applications of the application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedApplicationStatus": { + "type": "string", + "description": "The status of the application deployed on the node. Following are the possible values.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeployedApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Downloading", + "description": "Indicates that the package is downloading from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates that the package is activating. The value is 2." + }, + { + "value": "Active", + "description": "Indicates that the package is active. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates that the package is upgrading. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates that the package is deactivating. The value is 5." + } + ] + } + }, + "DeployedServicePackageHealth": { + "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "DeployedServicePackageHealth", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the service manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this service package is deployed." + } + } + } + ] + }, + "DeployedServicePackageHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackage", + "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "DeployedServicePackageHealthState": { + "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthState", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the manifest describing the service package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + } + ] + }, + "DeployedServicePackageHealthStateChunk": { + "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "DeployedServicePackageHealthStateChunk", + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + } + ] + }, + "DeployedServicePackageHealthStateChunkList": { + "type": "object", + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunk" + }, + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedServicePackageHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.", + "properties": { + "ServiceManifestNameFilter": { + "type": "string", + "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "ServicePackageActivationIdFilter": { + "type": "string", + "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "DeployedServicePackageHealthStateList": { + "description": "List of health states for a service package deployed on a Service Fabric node.", + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthState" + } + }, + "DeployedServicePackagesHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackages", + "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "DeployedServicePackagesHealthEvaluation", + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed service packages of the deployed application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "DeployedServiceReplicaInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that hosts this replica." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "Address": { + "type": "string", + "description": "The last address returned by the replica in Open or ChangeRole." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostProcessId": { + "type": "string", + "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel." + } + } + }, + "DeployedServiceReplicaInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + "description": "List of deployed service replica information." + }, + "DeployedStatefulServiceReplicaInfo": { + "description": "Information about a stateful service replica deployed on a node.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaInfo", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReconfigurationInformation": { + "$ref": "#/definitions/ReconfigurationInformation", + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time." + } + } + } + ] + }, + "DeployedStatelessServiceInstanceInfo": { + "description": "Information about a stateless service instance deployed on a node.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "EntityHealth": { + "type": "object", + "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy." + }, + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + }, + "description": "The list of health events reported on the entity." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager." + }, + "HealthStatistics": { + "$ref": "#/definitions/HealthStatistics", + "description": "Shows the health statistics for all children types of the queried entity." + } + } + }, + "EntityHealthState": { + "type": "object", + "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunk": { + "type": "object", + "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunkList": { + "type": "object", + "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.", + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description." + } + } + }, + "Epoch": { + "type": "object", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", + "properties": { + "ConfigurationVersion": { + "type": "string", + "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." + }, + "DataLossVersion": { + "type": "string", + "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + } + } + }, + "BackupEpoch": { + "type": "object", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", + "properties": { + "ConfigurationNumber": { + "type": "string", + "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." + }, + "DataLossNumber": { + "type": "string", + "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + } + } + }, + "EventHealthEvaluation": { + "x-ms-discriminator-value": "Event", + "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "EventHealthEvaluation", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity." + }, + "UnhealthyEvent": { + "$ref": "#/definitions/HealthEvent", + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager." + } + } + } + ] + }, + "EventList": { + "description": "A list of FabricEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FabricEvent" + } + }, + "FabricCodeVersionInfo": { + "type": "object", + "description": "Information about a Service Fabric code version.", + "properties": { + "CodeVersion": { + "description": "The product version of Service Fabric.", + "type": "string" + } + } + }, + "FabricCodeVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricCodeVersionInfo" + }, + "description": "List of all Service Fabric code versions." + }, + "FabricConfigVersionInfo": { + "type": "object", + "description": "Information about a Service Fabric config version.", + "properties": { + "ConfigVersion": { + "description": "The config version of Service Fabric.", + "type": "string" + } + } + }, + "FabricConfigVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricConfigVersionInfo" + }, + "description": "List of all Service Fabric config versions." + }, + "FabricError": { + "type": "object", + "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.", + "properties": { + "Error": { + "$ref": "#/definitions/FabricErrorError", + "description": "Error object containing error code and error message." + } + }, + "required": [ + "Error" + ] + }, + "FabricErrorError": { + "type": "object", + "description": "Error object containing error code and error message.", + "properties": { + "Code": { + "$ref": "#/definitions/FabricErrorCodes", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" + }, + "Message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "Code" + ] + }, + "FabricErrorCodes": { + "type": "string", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", + "enum": [ + "FABRIC_E_INVALID_PARTITION_KEY", + "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", + "FABRIC_E_INVALID_ADDRESS", + "FABRIC_E_APPLICATION_NOT_UPGRADING", + "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_FABRIC_NOT_UPGRADING", + "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_INVALID_CONFIGURATION", + "FABRIC_E_INVALID_NAME_URI", + "FABRIC_E_PATH_TOO_LONG", + "FABRIC_E_KEY_TOO_LARGE", + "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED", + "FABRIC_E_INVALID_ATOMIC_GROUP", + "FABRIC_E_VALUE_EMPTY", + "FABRIC_E_NODE_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_NOT_FOUND", + "FABRIC_E_APPLICATION_NOT_FOUND", + "FABRIC_E_SERVICE_TYPE_NOT_FOUND", + "FABRIC_E_SERVICE_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND", + "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND", + "FABRIC_E_PARTITION_NOT_FOUND", + "FABRIC_E_REPLICA_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST", + "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND", + "FABRIC_E_DIRECTORY_NOT_FOUND", + "FABRIC_E_FABRIC_VERSION_NOT_FOUND", + "FABRIC_E_FILE_NOT_FOUND", + "FABRIC_E_NAME_DOES_NOT_EXIST", + "FABRIC_E_PROPERTY_DOES_NOT_EXIST", + "FABRIC_E_ENUMERATION_COMPLETED", + "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND", + "FABRIC_E_KEY_NOT_FOUND", + "FABRIC_E_HEALTH_ENTITY_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS", + "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS", + "FABRIC_E_SERVICE_ALREADY_EXISTS", + "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_TYPE_IN_USE", + "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS", + "FABRIC_E_FABRIC_VERSION_IN_USE", + "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS", + "FABRIC_E_NAME_ALREADY_EXISTS", + "FABRIC_E_NAME_NOT_EMPTY", + "FABRIC_E_PROPERTY_CHECK_FAILED", + "FABRIC_E_SERVICE_METADATA_MISMATCH", + "FABRIC_E_SERVICE_TYPE_MISMATCH", + "FABRIC_E_HEALTH_STALE_REPORT", + "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED", + "FABRIC_E_NODE_HAS_NOT_STOPPED_YET", + "FABRIC_E_INSTANCE_ID_MISMATCH", + "FABRIC_E_VALUE_TOO_LARGE", + "FABRIC_E_NO_WRITE_QUORUM", + "FABRIC_E_NOT_PRIMARY", + "FABRIC_E_NOT_READY", + "FABRIC_E_RECONFIGURATION_PENDING", + "FABRIC_E_SERVICE_OFFLINE", + "E_ABORT", + "FABRIC_E_COMMUNICATION_ERROR", + "FABRIC_E_OPERATION_NOT_COMPLETE", + "FABRIC_E_TIMEOUT", + "FABRIC_E_NODE_IS_UP", + "E_FAIL", + "FABRIC_E_BACKUP_IS_ENABLED", + "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH", + "FABRIC_E_INVALID_FOR_STATELESS_SERVICES", + "FABRIC_E_BACKUP_NOT_ENABLED", + "FABRIC_E_BACKUP_POLICY_NOT_EXISTING", + "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING", + "FABRIC_E_BACKUP_IN_PROGRESS", + "FABRIC_E_RESTORE_IN_PROGRESS", + "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING", + "FABRIC_E_INVALID_SERVICE_SCALING_POLICY", + "E_INVALIDARG", + "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS", + "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND", + "FABRIC_E_VOLUME_ALREADY_EXISTS", + "FABRIC_E_VOLUME_NOT_FOUND", + "SerializationError" + ], + "x-ms-enum": { + "name": "FabricErrorCodes", + "modelAsString": true, + "values": [ + { + "value": "FABRIC_E_INVALID_PARTITION_KEY" + }, + { + "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_ADDRESS" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_FABRIC_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_CONFIGURATION" + }, + { + "value": "FABRIC_E_INVALID_NAME_URI" + }, + { + "value": "FABRIC_E_PATH_TOO_LONG" + }, + { + "value": "FABRIC_E_KEY_TOO_LARGE" + }, + { + "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" + }, + { + "value": "FABRIC_E_INVALID_ATOMIC_GROUP" + }, + { + "value": "FABRIC_E_VALUE_EMPTY" + }, + { + "value": "FABRIC_E_NODE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" + }, + { + "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" + }, + { + "value": "FABRIC_E_PARTITION_NOT_FOUND" + }, + { + "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" + }, + { + "value": "FABRIC_E_DIRECTORY_NOT_FOUND" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND" + }, + { + "value": "FABRIC_E_FILE_NOT_FOUND" + }, + { + "value": "FABRIC_E_NAME_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_ENUMERATION_COMPLETED" + }, + { + "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" + }, + { + "value": "FABRIC_E_KEY_NOT_FOUND" + }, + { + "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_SERVICE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_NAME_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_NAME_NOT_EMPTY" + }, + { + "value": "FABRIC_E_PROPERTY_CHECK_FAILED" + }, + { + "value": "FABRIC_E_SERVICE_METADATA_MISMATCH" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_MISMATCH" + }, + { + "value": "FABRIC_E_HEALTH_STALE_REPORT" + }, + { + "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" + }, + { + "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" + }, + { + "value": "FABRIC_E_INSTANCE_ID_MISMATCH" + }, + { + "value": "FABRIC_E_VALUE_TOO_LARGE" + }, + { + "value": "FABRIC_E_NO_WRITE_QUORUM" + }, + { + "value": "FABRIC_E_NOT_PRIMARY" + }, + { + "value": "FABRIC_E_NOT_READY" + }, + { + "value": "FABRIC_E_RECONFIGURATION_PENDING" + }, + { + "value": "FABRIC_E_SERVICE_OFFLINE" + }, + { + "value": "E_ABORT" + }, + { + "value": "FABRIC_E_COMMUNICATION_ERROR" + }, + { + "value": "FABRIC_E_OPERATION_NOT_COMPLETE" + }, + { + "value": "FABRIC_E_TIMEOUT" + }, + { + "value": "FABRIC_E_NODE_IS_UP" + }, + { + "value": "E_FAIL" + }, + { + "value": "FABRIC_E_BACKUP_IS_ENABLED" + }, + { + "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" + }, + { + "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" + }, + { + "value": "FABRIC_E_BACKUP_NOT_ENABLED" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" + }, + { + "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" + }, + { + "value": "FABRIC_E_BACKUP_IN_PROGRESS" + }, + { + "value": "FABRIC_E_RESTORE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" + }, + { + "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" + }, + { + "value": "E_INVALIDARG" + }, + { + "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND" + }, + { + "value": "FABRIC_E_VOLUME_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_VOLUME_NOT_FOUND" + }, + { + "value": "SerializationError" + } + ] + } + }, + "FabricEvent": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the base for all Fabric Events.", + "properties": { + "Kind": { + "$ref": "#/definitions/FabricEventKind", + "description": "The kind of FabricEvent." + }, + "EventInstanceId": { + "type": "string", + "format": "uuid", + "description": "The identifier for the FabricEvent instance." + }, + "TimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time event was logged." + }, + "HasCorrelatedEvents": { + "type": "boolean", + "description": "Shows there is existing related events available." + } + }, + "required": [ + "Kind", + "EventInstanceId", + "TimeStamp" + ] + }, + "FabricEventKind": { + "type": "string", + "description": "The kind of FabricEvent.", + "enum": [ + "ClusterEvent", + "ContainerInstanceEvent", + "NodeEvent", + "ApplicationEvent", + "ServiceEvent", + "PartitionEvent", + "ReplicaEvent", + "PartitionAnalysisEvent", + "ApplicationCreated", + "ApplicationDeleted", + "ApplicationHealthReportCreated", + "ApplicationHealthReportExpired", + "ApplicationUpgradeComplete", + "ApplicationUpgradeDomainComplete", + "ApplicationUpgradeRollbackComplete", + "ApplicationUpgradeRollbackStart", + "ApplicationUpgradeStart", + "DeployedApplicationHealthReportCreated", + "DeployedApplicationHealthReportExpired", + "ProcessDeactivated", + "ContainerDeactivated", + "NodeAborted", + "NodeAborting", + "NodeAdded", + "NodeClose", + "NodeClosing", + "NodeDeactivateComplete", + "NodeDeactivateStart", + "NodeDown", + "NodeHealthReportCreated", + "NodeHealthReportExpired", + "NodeOpenedSuccess", + "NodeOpenFailed", + "NodeOpening", + "NodeRemoved", + "NodeUp", + "PartitionHealthReportCreated", + "PartitionHealthReportExpired", + "PartitionReconfigurationCompleted", + "PartitionPrimaryMoveAnalysis", + "ServiceCreated", + "ServiceDeleted", + "ServiceHealthReportCreated", + "ServiceHealthReportExpired", + "DeployedServiceHealthReportCreated", + "DeployedServiceHealthReportExpired", + "StatefulReplicaHealthReportCreated", + "StatefulReplicaHealthReportExpired", + "StatelessReplicaHealthReportCreated", + "StatelessReplicaHealthReportExpired", + "ClusterHealthReportCreated", + "ClusterHealthReportExpired", + "ClusterUpgradeComplete", + "ClusterUpgradeDomainComplete", + "ClusterUpgradeRollbackComplete", + "ClusterUpgradeRollbackStart", + "ClusterUpgradeStart", + "ChaosStopped", + "ChaosStarted", + "ChaosRestartNodeFaultCompleted", + "ChaosRestartCodePackageFaultScheduled", + "ChaosRestartCodePackageFaultCompleted", + "ChaosRemoveReplicaFaultScheduled", + "ChaosRemoveReplicaFaultCompleted", + "ChaosMoveSecondaryFaultScheduled", + "ChaosMovePrimaryFaultScheduled", + "ChaosRestartReplicaFaultScheduled", + "ChaosRestartNodeFaultScheduled" + ], + "x-ms-enum": { + "name": "FabricEventKind", + "modelAsString": true, + "values": [ + { + "value": "ClusterEvent" + }, + { + "value": "ContainerInstanceEvent" + }, + { + "value": "NodeEvent" + }, + { + "value": "ApplicationEvent" + }, + { + "value": "ServiceEvent" + }, + { + "value": "PartitionEvent" + }, + { + "value": "ReplicaEvent" + }, + { + "value": "PartitionAnalysisEvent" + }, + { + "value": "ApplicationCreated" + }, + { + "value": "ApplicationDeleted" + }, + { + "value": "ApplicationHealthReportCreated" + }, + { + "value": "ApplicationHealthReportExpired" + }, + { + "value": "ApplicationUpgradeComplete" + }, + { + "value": "ApplicationUpgradeDomainComplete" + }, + { + "value": "ApplicationUpgradeRollbackComplete" + }, + { + "value": "ApplicationUpgradeRollbackStart" + }, + { + "value": "ApplicationUpgradeStart" + }, + { + "value": "DeployedApplicationHealthReportCreated" + }, + { + "value": "DeployedApplicationHealthReportExpired" + }, + { + "value": "ProcessDeactivated" + }, + { + "value": "ContainerDeactivated" + }, + { + "value": "NodeAborted" + }, + { + "value": "NodeAborting" + }, + { + "value": "NodeAdded" + }, + { + "value": "NodeClose" + }, + { + "value": "NodeClosing" + }, + { + "value": "NodeDeactivateComplete" + }, + { + "value": "NodeDeactivateStart" + }, + { + "value": "NodeDown" + }, + { + "value": "NodeHealthReportCreated" + }, + { + "value": "NodeHealthReportExpired" + }, + { + "value": "NodeOpenedSuccess" + }, + { + "value": "NodeOpenFailed" + }, + { + "value": "NodeOpening" + }, + { + "value": "NodeRemoved" + }, + { + "value": "NodeUp" + }, + { + "value": "PartitionHealthReportCreated" + }, + { + "value": "PartitionHealthReportExpired" + }, + { + "value": "PartitionReconfigurationCompleted" + }, + { + "value": "PartitionPrimaryMoveAnalysis" + }, + { + "value": "ServiceCreated" + }, + { + "value": "ServiceDeleted" + }, + { + "value": "ServiceHealthReportCreated" + }, + { + "value": "ServiceHealthReportExpired" + }, + { + "value": "DeployedServiceHealthReportCreated" + }, + { + "value": "DeployedServiceHealthReportExpired" + }, + { + "value": "StatefulReplicaHealthReportCreated" + }, + { + "value": "StatefulReplicaHealthReportExpired" + }, + { + "value": "StatelessReplicaHealthReportCreated" + }, + { + "value": "StatelessReplicaHealthReportExpired" + }, + { + "value": "ClusterHealthReportCreated" + }, + { + "value": "ClusterHealthReportExpired" + }, + { + "value": "ClusterUpgradeComplete" + }, + { + "value": "ClusterUpgradeDomainComplete" + }, + { + "value": "ClusterUpgradeRollbackComplete" + }, + { + "value": "ClusterUpgradeRollbackStart" + }, + { + "value": "ClusterUpgradeStart" + }, + { + "value": "ChaosStopped" + }, + { + "value": "ChaosStarted" + }, + { + "value": "ChaosRestartNodeFaultCompleted" + }, + { + "value": "ChaosRestartCodePackageFaultScheduled" + }, + { + "value": "ChaosRestartCodePackageFaultCompleted" + }, + { + "value": "ChaosRemoveReplicaFaultScheduled" + }, + { + "value": "ChaosRemoveReplicaFaultCompleted" + }, + { + "value": "ChaosMoveSecondaryFaultScheduled" + }, + { + "value": "ChaosMovePrimaryFaultScheduled" + }, + { + "value": "ChaosRestartReplicaFaultScheduled" + }, + { + "value": "ChaosRestartNodeFaultScheduled" + } + ] + } + }, + "ClusterConfigurationUpgradeStatusInfo": { + "type": "object", + "description": "Information about a standalone cluster configuration upgrade status.", + "properties": { + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "ProgressStatus": { + "type": "integer", + "description": "The cluster manifest version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "Details": { + "type": "string", + "description": "The cluster upgrade status details." + } + } + }, + "FailureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Invalid", + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rollback", + "description": "The upgrade will start rolling back automatically. The value is 1" + }, + { + "value": "Manual", + "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2" + } + ] + } + }, + "FailureReason": { + "type": "string", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed.", + "enum": [ + "None", + "Interrupted", + "HealthCheck", + "UpgradeDomainTimeout", + "OverallUpgradeTimeout" + ], + "x-ms-enum": { + "name": "FailureReason", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Interrupted", + "description": "There was an external request to roll back the upgrade. The value is 1" + }, + { + "value": "HealthCheck", + "description": "The upgrade failed due to health policy violations. The value is 2" + }, + { + "value": "UpgradeDomainTimeout", + "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3" + }, + { + "value": "OverallUpgradeTimeout", + "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4" + } + ] + } + }, + "FailureUpgradeDomainProgressInfo": { + "type": "object", + "description": "Information about the upgrade domain progress at the time of upgrade failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H10M0S" + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "0" + }, + "HealthEvaluation": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.", + "properties": { + "Kind": { + "$ref": "#/definitions/HealthEvaluationKind", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values." + }, + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "Description": { + "type": "string", + "description": "Description of the health evaluation, which represents a summary of the evaluation process." + } + }, + "required": [ + "Kind" + ] + }, + "HealthEvaluationKind": { + "type": "string", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.", + "enum": [ + "Invalid", + "Event", + "Replicas", + "Partitions", + "DeployedServicePackages", + "DeployedApplications", + "Services", + "Nodes", + "Applications", + "SystemApplication", + "UpgradeDomainDeployedApplications", + "UpgradeDomainNodes", + "Replica", + "Partition", + "DeployedServicePackage", + "DeployedApplication", + "Service", + "Node", + "Application", + "DeltaNodesCheck", + "UpgradeDomainDeltaNodesCheck", + "ApplicationTypeApplications" + ], + "x-ms-enum": { + "name": "HealthEvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the health evaluation is invalid. The value is zero." + }, + { + "value": "Event", + "description": "Indicates that the health evaluation is for a health event. The value is 1." + }, + { + "value": "Replicas", + "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2." + }, + { + "value": "Partitions", + "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3." + }, + { + "value": "DeployedServicePackages", + "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4." + }, + { + "value": "DeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5." + }, + { + "value": "Services", + "description": "Indicates that the health evaluation is for services of an application. The value is 6." + }, + { + "value": "Nodes", + "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7." + }, + { + "value": "Applications", + "description": "Indicates that the health evaluation is for the cluster applications. The value is 8." + }, + { + "value": "SystemApplication", + "description": "Indicates that the health evaluation is for the system application. The value is 9." + }, + { + "value": "UpgradeDomainDeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10." + }, + { + "value": "UpgradeDomainNodes", + "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11." + }, + { + "value": "Replica", + "description": "Indicates that the health evaluation is for a replica. The value is 13." + }, + { + "value": "Partition", + "description": "Indicates that the health evaluation is for a partition. The value is 14." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates that the health evaluation is for a deployed service package. The value is 16." + }, + { + "value": "DeployedApplication", + "description": "Indicates that the health evaluation is for a deployed application. The value is 17." + }, + { + "value": "Service", + "description": "Indicates that the health evaluation is for a service. The value is 15." + }, + { + "value": "Node", + "description": "Indicates that the health evaluation is for a node. The value is 12." + }, + { + "value": "Application", + "description": "Indicates that the health evaluation is for an application. The value is 18." + }, + { + "value": "DeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19." + }, + { + "value": "UpgradeDomainDeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20." + }, + { + "value": "ApplicationTypeApplications", + "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21." + } + ] + } + }, + "HealthEvaluationWrapper": { + "type": "object", + "description": "Wrapper object for health evaluation.", + "properties": { + "HealthEvaluation": { + "$ref": "#/definitions/HealthEvaluation", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity." + } + } + }, + "HealthEvent": { + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.", + "allOf": [ + { + "$ref": "#/definitions/HealthInformation" + }, + { + "type": "object", + "description": "HealthEvent", + "properties": { + "IsExpired": { + "type": "boolean", + "description": "Returns true if the health event is expired, otherwise false." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was sent by the source." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was last modified by the health store." + }, + "LastOkTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time." + }, + "LastWarningTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time." + }, + "LastErrorTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time." + } + } + } + ] + }, + "HealthInformation": { + "type": "object", + "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.", + "required": [ + "SourceId", + "Property", + "HealthState" + ], + "properties": { + "SourceId": { + "type": "string", + "description": "The source name that identifies the client/watchdog/system component that generated the health information." + }, + "Property": { + "type": "string", + "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "TimeToLiveInMilliSeconds": { + "type": "string", + "format": "duration", + "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value." + }, + "Description": { + "type": "string", + "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string." + }, + "SequenceNumber": { + "type": "string", + "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, is the reporter has issues (eg. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state." + } + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "Int64RangePartitionInformation": { + "description": "Describes the partition information for the integer range that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Int64Range", + "properties": { + "LowKey": { + "type": "string", + "description": "Specifies the minimum key value handled by this partition." + }, + "HighKey": { + "type": "string", + "description": "Specifies the maximum key value handled by this partition." + } + } + }, + "MonitoringPolicyDescription": { + "type": "object", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode.", + "properties": { + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + } + }, + "NamedPartitionInformation": { + "description": "Describes the partition information for the name as a string that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Named", + "properties": { + "Name": { + "type": "string", + "description": "Name of the partition." + } + } + }, + "NextUpgradeDomain": { + "type": "string", + "description": "The name of the next upgrade domain to be processed." + }, + "NodeDeactivationInfo": { + "type": "object", + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.", + "properties": { + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + }, + "NodeDeactivationStatus": { + "$ref": "#/definitions/NodeDeactivationStatus", + "description": "The status of node deactivation operation. Following are the possible values." + }, + "NodeDeactivationTask": { + "$ref": "#/definitions/NodeDeactivationTaskList", + "description": "List of tasks representing the deactivation operation on the node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeDeactivationIntent": { + "type": "string", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it.", + "enum": [ + "Invalid", + "Pause", + "Restart", + "RemoveData", + "RemoveNode" + ], + "x-ms-enum": { + "name": "NodeDeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3." + }, + { + "value": "RemoveNode", + "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4." + } + ] + } + }, + "NodeDeactivationStatus": { + "type": "string", + "description": "The status of node deactivation operation. Following are the possible values.", + "enum": [ + "None", + "SafetyCheckInProgress", + "SafetyCheckComplete", + "Completed" + ], + "x-ms-enum": { + "name": "NodeDeactivationStatus", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No status is associated with the task. The value is zero." + }, + { + "value": "SafetyCheckInProgress", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1." + }, + { + "value": "SafetyCheckComplete", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2." + }, + { + "value": "Completed", + "description": "The task is completed. The value is 3." + } + ] + } + }, + "NodeDeactivationTask": { + "type": "object", + "description": "The task representing the deactivation operation on the node.", + "properties": { + "NodeDeactivationTaskId": { + "$ref": "#/definitions/NodeDeactivationTaskId", + "description": "Identity of the task related to deactivation operation on the node." + }, + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + } + } + }, + "NodeDeactivationTaskId": { + "type": "object", + "description": "Identity of the task related to deactivation operation on the node.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the task id." + }, + "NodeDeactivationTaskType": { + "$ref": "#/definitions/NodeDeactivationTaskType", + "description": "The type of the task that performed the node deactivation. Following are the possible values." + } + } + }, + "NodeDeactivationTaskList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeDeactivationTask" + }, + "description": "List of tasks representing the deactivation operation on the node." + }, + "NodeDeactivationTaskType": { + "type": "string", + "description": "The type of the task that performed the node deactivation. Following are the possible values.", + "enum": [ + "Invalid", + "Infrastructure", + "Repair", + "Client" + ], + "x-ms-enum": { + "name": "NodeDeactivationTaskType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Infrastructure", + "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1." + }, + { + "value": "Repair", + "description": "Specifies the task that was created by the Repair Manager service. The value is 2." + }, + { + "value": "Client", + "description": "Specifies that the task was created by using the public API. The value is 3." + } + ] + } + }, + "NodeEvent": { + "description": "Represents the base for all Node Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "NodeEvent", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + }, + "required": [ + "NodeName" + ] + } + ], + "x-ms-discriminator-value": "NodeEvent" + }, + "NodeEventList": { + "description": "A list of NodeEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeEvent" + } + }, + "NodeHealth": { + "description": "Information about the health of a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "NodeHealth", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node whose health information is described by this object." + } + } + } + ] + }, + "NodeHealthEvaluation": { + "x-ms-discriminator-value": "Node", + "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "NodeHealthEvaluation", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "NodeHealthState": { + "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "NodeHealthState", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + } + } + } + ] + }, + "NodeHealthStateChunk": { + "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "NodeHealthStateChunk", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + } + } + ] + }, + "NodeHealthStateChunkList": { + "type": "object", + "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + }, + { + "type": "object", + "description": "NodeHealthStateChunkList", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateChunk" + }, + "description": "The list of node health state chunks that respect the input filters in the chunk query." + } + } + } + ] + }, + "NodeHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "NodeId": { + "type": "object", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the node Id. This is a 128 bit integer." + } + } + }, + "NodeIdList": { + "description": "A list of NodeIds.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeId" + } + }, + "NodeInfo": { + "type": "object", + "description": "Information about a node in Service Fabric cluster.", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "The IP address or fully qualified domain name of the node." + }, + "Type": { + "type": "string", + "description": "The type of the node." + }, + "CodeVersion": { + "type": "string", + "description": "The version of Service Fabric binaries that the node is running." + }, + "ConfigVersion": { + "type": "string", + "description": "The version of Service Fabric cluster manifest that the node is using." + }, + "NodeStatus": { + "$ref": "#/definitions/NodeStatus", + "description": "The status of the node." + }, + "NodeUpTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster." + }, + "UpgradeDomain": { + "type": "string", + "description": "The upgrade domain of the node." + }, + "FaultDomain": { + "type": "string", + "description": "The fault domain of the node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + }, + "InstanceId": { + "type": "string", + "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts." + }, + "NodeDeactivationInfo": { + "$ref": "#/definitions/NodeDeactivationInfo", + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated." + }, + "IsStopped": { + "type": "boolean", + "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false." + }, + "NodeDownTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down." + }, + "NodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time." + }, + "NodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time." + } + } + }, + "NodeLoadInfo": { + "type": "object", + "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node for which the load information is provided by this object." + }, + "NodeLoadMetricInformation": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeLoadMetricInformation" + }, + "description": "List that contains metrics and their load information on this node." + } + } + }, + "NodeLoadMetricInformation": { + "type": "object", + "description": "Represents data structure that contains load information for a certain metric on a node.", + "properties": { + "Name": { + "type": "string", + "description": "Name of the metric for which this load information is provided." + }, + "NodeCapacity": { + "type": "string", + "description": "Total capacity on the node for this metric." + }, + "NodeLoad": { + "type": "string", + "description": "Current load on the node for this metric." + }, + "NodeRemainingCapacity": { + "type": "string", + "description": "The remaining capacity on the node for this metric." + }, + "IsCapacityViolation": { + "type": "boolean", + "description": "Indicates if there is a capacity violation for this metric on the node." + }, + "NodeBufferedCapacity": { + "type": "string", + "description": "The value that indicates the reserved capacity for this metric on the node." + }, + "NodeRemainingBufferedCapacity": { + "type": "string", + "description": "The remaining reserved capacity for this metric on the node." + } + } + }, + "NodeName": { + "type": "string", + "description": "The name of a Service Fabric node." + }, + "NodeType": { + "type": "string", + "description": "The type name of a Service Fabric node.\nRefer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-nodetypes) for more details." + }, + "NodesHealthEvaluation": { + "x-ms-discriminator-value": "Nodes", + "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "NodesHealthEvaluation", + "properties": { + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "NodeStatus": { + "type": "string", + "description": "The status of the node.", + "enum": [ + "Invalid", + "Up", + "Down", + "Enabling", + "Disabling", + "Disabled", + "Unknown", + "Removed" + ], + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Up", + "description": "Indicates the node is up. The value is 1." + }, + { + "value": "Down", + "description": "Indicates the node is down. The value is 2." + }, + { + "value": "Enabling", + "description": "Indicates the node is in process of being enabled. The value is 3." + }, + { + "value": "Disabling", + "description": "Indicates the node is in the process of being disabled. The value is 4." + }, + { + "value": "Disabled", + "description": "Indicates the node is disabled. The value is 5." + }, + { + "value": "Unknown", + "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6." + }, + { + "value": "Removed", + "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7." + } + ] + } + }, + "NodeUpgradePhase": { + "type": "string", + "description": "The state of the upgrading node.", + "enum": [ + "Invalid", + "PreUpgradeSafetyCheck", + "Upgrading", + "PostUpgradeSafetyCheck" + ], + "x-ms-enum": { + "name": "NodeUpgradePhase", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PreUpgradeSafetyCheck", + "description": "The upgrade has not started yet due to pending safety checks. The value is 1" + }, + { + "value": "Upgrading", + "description": "The upgrade is in progress. The value is 2" + }, + { + "value": "PostUpgradeSafetyCheck", + "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3" + } + ] + } + }, + "NodeUpgradeProgressInfo": { + "type": "object", + "description": "Information about the upgrading node and its status", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UpgradePhase": { + "$ref": "#/definitions/NodeUpgradePhase", + "description": "The state of the upgrading node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeUpgradeProgressInfoList": { + "type": "array", + "description": "List of upgrading nodes and their statuses", + "items": { + "$ref": "#/definitions/NodeUpgradeProgressInfo" + } + }, + "PagedApplicationInfoList": { + "type": "object", + "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application information.", + "items": { + "$ref": "#/definitions/ApplicationInfo" + } + } + } + }, + "PagedDeployedApplicationInfoList": { + "type": "object", + "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of deployed application information.", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + } + } + }, + "PagedNodeInfoList": { + "type": "object", + "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of node information.", + "items": { + "$ref": "#/definitions/NodeInfo" + } + } + } + }, + "PagedServicePartitionInfoList": { + "type": "object", + "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service partition information.", + "items": { + "$ref": "#/definitions/ServicePartitionInfo" + } + } + } + }, + "PagedReplicaInfoList": { + "type": "object", + "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of replica information.", + "items": { + "$ref": "#/definitions/ReplicaInfo" + } + } + } + }, + "PagedServiceInfoList": { + "type": "object", + "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service information.", + "items": { + "$ref": "#/definitions/ServiceInfo" + } + } + } + }, + "PartitionAnalysisEvent": { + "description": "Represents the base for all Partition Analysis Events.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "description": "PartitionAnalysisEvent", + "properties": { + "Metadata": { + "$ref": "#/definitions/AnalysisEventMetadata", + "description": "Metadata about an Analysis Event." + } + }, + "required": [ + "Metadata" + ] + } + ], + "x-ms-discriminator-value": "PartitionAnalysisEvent" + }, + "PartitionEvent": { + "description": "Represents the base for all Partition Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "PartitionEvent", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "PartitionId" + ] + } + ], + "x-ms-discriminator-value": "PartitionEvent" + }, + "PartitionEventList": { + "description": "A list of PartitionEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PartitionEvent" + } + }, + "PartitionHealth": { + "description": "Information about the health of a Service Fabric partition.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "PartitionHealth", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "ID of the partition whose health information is described by this object." + }, + "ReplicaHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthState" + }, + "description": "The list of replica health states associated with the partition." + } + } + } + ] + }, + "PartitionHealthEvaluation": { + "x-ms-discriminator-value": "Partition", + "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "PartitionHealthEvaluation", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "PartitionHealthState": { + "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "PartitionHealthState", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health state is described by this object." + } + } + } + ] + }, + "PartitionHealthStateChunk": { + "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "PartitionHealthStateChunk", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The Id of the partition." + }, + "ReplicaHealthStateChunks": { + "$ref": "#/definitions/ReplicaHealthStateChunkList", + "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "PartitionHealthStateChunkList": { + "type": "object", + "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateChunk" + }, + "description": "The list of partition health state chunks that respect the input filters in the chunk query." + } + } + }, + "PartitionHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.", + "properties": { + "PartitionIdFilter": { + "type": "string", + "format": "uuid", + "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ReplicaFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateFilter" + }, + "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id." + } + } + }, + "PartitionId": { + "type": "string", + "format": "uuid", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "PartitionInformation": { + "type": "object", + "discriminator": "ServicePartitionKind", + "description": "Information about the partition identity, partitioning scheme and keys supported by it.", + "required": [ + "ServicePartitionKind" + ], + "properties": { + "ServicePartitionKind": { + "$ref": "#/definitions/ServicePartitionKind", + "description": "The kind of partitioning scheme used to partition the service." + }, + "Id": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "ProvisionFabricDescription": { + "type": "object", + "description": "Describes the parameters for provisioning a cluster.", + "properties": { + "CodeFilePath": { + "type": "string", + "description": "The cluster code package file path." + }, + "ClusterManifestFilePath": { + "type": "string", + "description": "The cluster manifest file path." + } + } + }, + "ProvisionApplicationTypeKind": { + "type": "string", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.", + "enum": [ + "Invalid", + "ImageStorePath", + "ExternalStore" + ], + "x-ms-enum": { + "name": "ProvisionApplicationTypeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero." + }, + { + "value": "ImageStorePath", + "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1." + }, + { + "value": "ExternalStore", + "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2." + } + ] + } + }, + "ProvisionApplicationTypeDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.", + "properties": { + "Kind": { + "$ref": "#/definitions/ProvisionApplicationTypeKind", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision." + }, + "Async": { + "type": "boolean", + "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true." + } + }, + "required": [ + "Kind", + "Async" + ] + }, + "ProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.", + "required": [ + "ApplicationTypeBuildPath" + ], + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + }, + { + "type": "object", + "description": "ProvisionApplicationTypeDescription", + "properties": { + "ApplicationTypeBuildPath": { + "description": "The relative path for the application package in the image store specified during the prior upload operation.", + "type": "string" + }, + "ApplicationPackageCleanupPolicy": { + "$ref": "#/definitions/ApplicationPackageCleanupPolicy", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision." + } + } + } + ], + "x-ms-discriminator-value": "ImageStorePath" + }, + "ExternalStoreProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + }, + { + "type": "object", + "description": "ExternalStoreProvisionApplicationTypeDescription", + "properties": { + "ApplicationPackageDownloadUri": { + "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.", + "type": "string" + }, + "ApplicationTypeName": { + "description": "The application type name represents the name of the application type found in the application manifest.", + "type": "string" + }, + "ApplicationTypeVersion": { + "description": "The application type version represents the version of the application type found in the application manifest.", + "type": "string" + } + } + } + ], + "x-ms-discriminator-value": "ExternalStore", + "required": [ + "ApplicationPackageDownloadUri", + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + }, + "UnprovisionFabricDescription": { + "type": "object", + "description": "Describes the parameters for unprovisioning a cluster.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code package version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster manifest version." + } + } + }, + "ResumeClusterUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for resuming a cluster upgrade.", + "properties": { + "UpgradeDomain": { + "type": "string", + "description": "The next upgrade domain for this cluster upgrade." + } + }, + "required": [ + "UpgradeDomain" + ] + }, + "StartClusterUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for starting a cluster upgrade.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "UpdateClusterUpgradeDescription": { + "description": "Parameters for updating a cluster upgrade.", + "properties": { + "UpgradeKind": { + "$ref": "#/definitions/UpgradeType", + "description": "The type of upgrade out of the following possible values." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "SafetyCheckKind": { + "type": "string", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.", + "enum": [ + "Invalid", + "EnsureSeedNodeQuorum", + "EnsurePartitionQuorum", + "WaitForPrimaryPlacement", + "WaitForPrimarySwap", + "WaitForReconfiguration", + "WaitForInbuildReplica", + "EnsureAvailability" + ], + "x-ms-enum": { + "name": "SafetyCheckKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "EnsureSeedNodeQuorum", + "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1." + }, + { + "value": "EnsurePartitionQuorum", + "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2." + }, + { + "value": "WaitForPrimaryPlacement", + "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3." + }, + { + "value": "WaitForPrimarySwap", + "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4." + }, + { + "value": "WaitForReconfiguration", + "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5." + }, + { + "value": "WaitForInbuildReplica", + "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6." + }, + { + "value": "EnsureAvailability", + "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7." + } + ] + } + }, + "SafetyCheck": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "Kind": { + "$ref": "#/definitions/SafetyCheckKind", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionSafetyCheck": { + "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + }, + { + "type": "object", + "description": "PartitionSafetyCheck", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition which is undergoing the safety check." + } + } + } + ] + }, + "EnsureAvailabilitySafetyCheck": { + "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "EnsureAvailabilitySafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureAvailability" + }, + "EnsurePartitionQurumSafetyCheck": { + "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "EnsurePartitionQurumSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsurePartitionQuorum" + }, + "SeedNodeSafetyCheck": { + "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + }, + { + "type": "object", + "description": "SeedNodeSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureSeedNodeQuorum" + }, + "PartitionsHealthEvaluation": { + "x-ms-discriminator-value": "Partitions", + "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "PartitionsHealthEvaluation", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of partitions of the service from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ReplicaEvent": { + "description": "Represents the base for all Replica Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ReplicaEvent", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId_Integer", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + }, + "required": [ + "PartitionId", + "ReplicaId" + ] + } + ], + "x-ms-discriminator-value": "ReplicaEvent" + }, + "ReplicaEventList": { + "description": "A list of ReplicaEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaEvent" + } + }, + "ReplicaHealth": { + "discriminator": "ServiceKind", + "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ReplicaHealth", + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which this replica belongs." + } + }, + "required": [ + "ServiceKind" + ] + } + ] + }, + "ReplicaHealthEvaluation": { + "x-ms-discriminator-value": "Replica", + "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ReplicaHealthEvaluation", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which the replica belongs." + }, + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + } + ] + }, + "ReplicaHealthState": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "description": "Represents a base class for stateful service replica or stateless service instance health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ReplicaHealthState", + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The ID of the partition to which this replica belongs." + } + } + } + ] + }, + "ReplicaHealthStateChunk": { + "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ReplicaHealthStateChunk", + "properties": { + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + } + } + } + ] + }, + "ReplicaHealthStateChunkList": { + "type": "object", + "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateChunk" + }, + "description": "The list of replica health state chunks that respect the input filters in the chunk query." + } + } + }, + "ReplicaHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.", + "properties": { + "ReplicaOrInstanceIdFilter": { + "type": "string", + "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "ReplicaId": { + "type": "string", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaId_Integer": { + "type": "integer", + "format": "int64", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaOrInstanceId": { + "type": "string", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "ReplicaInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Address": { + "type": "string", + "description": "The address the replica is listening on." + }, + "LastInBuildDurationInSeconds": { + "type": "string", + "description": "The last in build duration of the replica in seconds." + } + } + }, + "ReplicaRole": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Primary", + "IdleSecondary", + "ActiveSecondary" + ], + "x-ms-enum": { + "name": "ReplicaRole", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the initial role that a replica is created in. The value is zero." + }, + { + "value": "None", + "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1" + }, + { + "value": "Primary", + "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2." + }, + { + "value": "IdleSecondary", + "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3." + }, + { + "value": "ActiveSecondary", + "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4." + } + ] + } + }, + "ReplicasHealthEvaluation": { + "x-ms-discriminator-value": "Replicas", + "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ReplicasHealthEvaluation", + "properties": { + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of replicas in the partition from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ReplicaStatus": { + "type": "string", + "description": "The status of a replica of a service.", + "enum": [ + "Invalid", + "InBuild", + "Standby", + "Ready", + "Down", + "Dropped" + ], + "x-ms-enum": { + "name": "ReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InBuild", + "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1." + }, + { + "value": "Standby", + "description": "The replica is in standby. The value is 2." + }, + { + "value": "Ready", + "description": "The replica is ready. The value is 3." + }, + { + "value": "Down", + "description": "The replica is down. The value is 4." + }, + { + "value": "Dropped", + "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5." + } + ] + } + }, + "RestartNodeDescription": { + "description": "Describes the parameters to restart a Service Fabric node.", + "properties": { + "NodeInstanceId": { + "type": "string", + "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.", + "default": "0" + }, + "CreateFabricDump": { + "type": "string", + "description": "Specify True to create a dump of the fabric node process. This is case-sensitive.", + "enum": [ + "False", + "True" + ], + "default": "False", + "x-ms-enum": { + "name": "CreateFabricDump", + "modelAsString": true, + "values": [ + { + "value": "False" + }, + { + "value": "True" + } + ] + } + } + }, + "required": [ + "NodeInstanceId" + ] + }, + "SafetyCheckInfoList": { + "type": "array", + "description": "List of pending safety checks", + "items": { + "$ref": "#/definitions/SafetyCheckWrapper" + } + }, + "SafetyCheckWrapper": { + "type": "object", + "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "SafetyCheck": { + "$ref": "#/definitions/SafetyCheck", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state." + } + } + }, + "ServiceEvent": { + "description": "Represents the base for all Service Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + }, + { + "type": "object", + "description": "ServiceEvent", + "properties": { + "ServiceId": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + } + }, + "required": [ + "ServiceId" + ] + } + ], + "x-ms-discriminator-value": "ServiceEvent" + }, + "ServiceEventList": { + "description": "A list of ServiceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEvent" + } + }, + "ServiceFromTemplateDescription": { + "type": "object", + "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.", + "required": [ + "ApplicationName", + "ServiceName", + "ServiceTypeName" + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data for the newly created service instance." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + } + } + }, + "ServiceHealthEvaluation": { + "x-ms-discriminator-value": "Service", + "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ServiceHealthEvaluation", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "ServiceHealthState": { + "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + }, + { + "type": "object", + "description": "ServiceHealthState", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health state is represented by this object." + } + } + } + ] + }, + "ServiceHealthStateChunk": { + "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + }, + { + "type": "object", + "description": "ServiceHealthStateChunk", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health state chunk is provided in this object." + }, + "PartitionHealthStateChunks": { + "$ref": "#/definitions/PartitionHealthStateChunkList", + "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description." + } + } + } + ] + }, + "ServiceHealthStateChunkList": { + "type": "object", + "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateChunk" + }, + "description": "The list of service health state chunks that respect the input filters in the chunk query." + } + } + }, + "ServiceHealthStateFilter": { + "type": "object", + "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.", + "properties": { + "ServiceNameFilter": { + "type": "string", + "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "PartitionFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateFilter" + }, + "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID." + } + } + }, + "ServiceHealth": { + "description": "Information about the health of a Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + }, + { + "type": "object", + "description": "ServiceHealth", + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health information is described by this object." + }, + "PartitionHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthState" + }, + "description": "The list of partition health states associated with the service." + } + } + } + ] + }, + "ServiceId": { + "type": "string", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "type": "string", + "description": "The name of the service manifest." + }, + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ManifestVersion": { + "description": "The version of the service manifest.", + "type": "string" + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ServiceStatus": { + "$ref": "#/definitions/ServiceStatus", + "description": "The status of the application." + }, + "IsServiceGroup": { + "description": "Whether the service is in a service group.", + "type": "boolean" + } + }, + "required": [ + "ServiceKind" + ] + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Invalid", + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ServiceNameInfo": { + "type": "object", + "description": "Information about the service name.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + }, + "ServicePackageActivationId": { + "type": "string", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "ServicePartitionInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a partition of a Service Fabric service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "PartitionStatus": { + "$ref": "#/definitions/ServicePartitionStatus", + "description": "The status of the service fabric service partition." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition identity, partitioning scheme and keys supported by it." + } + } + }, + "ServicePartitionKind": { + "type": "string", + "description": "The kind of partitioning scheme used to partition the service.", + "enum": [ + "Invalid", + "Singleton", + "Int64Range", + "Named" + ], + "x-ms-enum": { + "name": "ServicePartitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1." + }, + { + "value": "Int64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3." + } + ] + } + }, + "ServicePartitionStatus": { + "type": "string", + "description": "The status of the service fabric service partition.", + "enum": [ + "Invalid", + "Ready", + "NotReady", + "InQuorumLoss", + "Reconfiguring", + "Deleting" + ], + "x-ms-enum": { + "name": "ServicePartitionStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1." + }, + { + "value": "NotReady", + "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2." + }, + { + "value": "InQuorumLoss", + "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3." + }, + { + "value": "Reconfiguring", + "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the partition is being deleted. The value is 5." + } + ] + } + }, + "ServicePlacementInvalidDomainPolicyDescription": { + "x-ms-discriminator-value": "InvalidDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + } + ] + }, + "ServicePlacementNonPartiallyPlaceServicePolicyDescription": { + "x-ms-discriminator-value": "NonPartiallyPlaceService", + "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicyDescription" + } + ] + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "description": "The type of placement policy for a service fabric service. Following are the possible values." + } + } + }, + "ServicePlacementPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "List of service placement policy descriptions." + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicyDescription": { + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequiredDomainPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicePlacementRequireDomainDistributionPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomainDistribution", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicyDescription", + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + } + ] + }, + "ServicesHealthEvaluation": { + "x-ms-discriminator-value": "Services", + "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "ServicesHealthEvaluation", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type of the services." + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of services of the current service type in the application from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "ServiceStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the service status is unknown. The value is zero." + }, + { + "value": "Active", + "description": "Indicates the service status is active. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the service is upgrading. The value is 2." + }, + { + "value": "Deleting", + "description": "Indicates the service is being deleted. The value is 3." + }, + { + "value": "Creating", + "description": "Indicates the service is being created. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5." + } + ] + } + }, + "ServiceTypeDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPolicyDescriptionList", + "description": "List of service placement policy descriptions." + }, + "Extensions": { + "$ref": "#/definitions/ServiceTypeExtensionDescriptionList", + "description": "List of service type extensions." + } + } + }, + "ServiceTypeExtensionDescription": { + "type": "object", + "description": "Describes extension of a service type defined in the service manifest.", + "properties": { + "Key": { + "type": "string", + "description": "The name of the extension." + }, + "Value": { + "type": "string", + "description": "The extension value." + } + } + }, + "ServiceTypeExtensionDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeExtensionDescription" + }, + "description": "List of service type extensions." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", + "default": 0 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" + }, + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation." + }, + "ServiceTypeHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ServiceTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the service type health policy map item. This is the name of the service type." + }, + "Value": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type." + } + } + }, + "ServiceTypeInfo": { + "type": "object", + "description": "Information about a service type that is defined in a service manifest of a provisioned application type.", + "properties": { + "ServiceTypeDescription": { + "$ref": "#/definitions/ServiceTypeDescription", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "ServiceManifestVersion": { + "type": "string", + "description": "The version of the service manifest in which this service type is defined." + }, + "IsServiceGroup": { + "type": "boolean", + "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false." + } + } + }, + "ServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeInfo" + }, + "description": "List of service type information." + }, + "ServiceTypeManifest": { + "type": "object", + "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "SingletonPartitionInformation": { + "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceInfo": { + "description": "Information about a stateful Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + }, + { + "type": "object", + "description": "StatefulService", + "properties": { + "HasPersistedState": { + "description": "Whether the service has persisted state.", + "type": "boolean" + } + } + } + ], + "x-ms-discriminator-value": "Stateful" + }, + "StatefulServicePartitionInfo": { + "description": "Information about a partition of a stateful Service Fabric service..", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + }, + { + "type": "object", + "description": "StatefulServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The minimum replica set size as a number." + }, + "LastQuorumLossDuration": { + "type": "string", + "format": "duration", + "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration." + }, + "CurrentConfigurationEpoch": { + "$ref": "#/definitions/Epoch", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica." + } + } + }, + "StatefulServiceReplicaHealth": { + "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealth", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatefulServiceReplicaHealthState": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + }, + { + "type": "object", + "description": "StatefulServiceReplicaHealthState", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatefulServiceTypeDescription": { + "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + }, + { + "type": "object", + "description": "StatefulServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + } + } + }, + "StatelessServiceInfo": { + "description": "Information about a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + }, + { + "type": "object", + "description": "StatelessService" + } + ], + "x-ms-discriminator-value": "Stateless" + }, + "StatelessServiceInstanceHealth": { + "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealth", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "StatelessServiceInstanceHealthState": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + }, + { + "type": "object", + "description": "StatelessServiceInstanceHealthState", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of the stateless service instance on the wire this field is called ReplicaId." + } + } + } + ] + }, + "StatelessServicePartitionInfo": { + "description": "Information about a partition of a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + }, + { + "type": "object", + "description": "StatelessServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "format": "int64", + "description": "Number of instances of this partition." + } + } + }, + "StatelessServiceTypeDescription": { + "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + }, + { + "type": "object", + "description": "StatelessServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "UseImplicitHost": { + "type": "boolean", + "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise." + } + } + }, + "SystemApplicationHealthEvaluation": { + "x-ms-discriminator-value": "SystemApplication", + "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "SystemApplicationHealthEvaluation", + "properties": { + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + } + ] + }, + "TargetApplicationName": { + "type": "string", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "type": "string", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "TargetDeploymentName": { + "type": "string", + "description": "The name of the target deployment." + }, + "UnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "UpgradeDomainDeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck", + "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "UpgradeDomainDeltaNodesCheckHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "UpgradeDomainInfo": { + "type": "object", + "description": "Information about an upgrade domain.", + "properties": { + "Name": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "State": { + "$ref": "#/definitions/UpgradeDomainState", + "description": "The state of the upgrade domain." + } + } + }, + "UpgradeDomainInfoList": { + "type": "array", + "description": "List of upgrade domains and their statuses.", + "items": { + "$ref": "#/definitions/UpgradeDomainInfo" + } + }, + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain" + }, + "UpgradeDomainNodesHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainNodes", + "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + }, + { + "type": "object", + "description": "UpgradeDomainNodesHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + } + ] + }, + "UpgradeDomainState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "Pending", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "UpgradeDomainState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Pending", + "description": "The upgrade domain has not started upgrading yet. The value is 1" + }, + { + "value": "InProgress", + "description": "The upgrade domain is being upgraded but not complete yet. The value is 2" + }, + { + "value": "Completed", + "description": "The upgrade domain has completed upgrade. The value is 3" + } + ] + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeDuration": { + "type": "string", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "UpgradeKind": { + "type": "string", + "description": "The kind of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1" + } + ] + } + }, + "UpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.", + "enum": [ + "Invalid", + "UnmonitoredAuto", + "UnmonitoredManual", + "Monitored" + ], + "default": "UnmonitoredAuto", + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1" + }, + { + "value": "UnmonitoredManual", + "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2" + }, + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3" + } + ] + } + }, + "UpgradeType": { + "type": "string", + "description": "The type of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling", + "Rolling_ForceRestart" + ], + "x-ms-enum": { + "name": "UpgradeType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1." + }, + { + "value": "Rolling_ForceRestart", + "description": "The upgrade gets restarted by force. The value is 2." + } + ] + } + }, + "UpgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", + "default": 42949672925 + }, + "UpgradeState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "RollingBackInProgress", + "RollingBackCompleted", + "RollingForwardPending", + "RollingForwardInProgress", + "RollingForwardCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1" + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 2" + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4" + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5" + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6" + } + ] + } + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "WaitForInbuildReplicaSafetyCheck": { + "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForInbuildReplicaSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForInbuildReplica" + }, + "WaitForPrimaryPlacementSafetyCheck": { + "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForPrimaryPlacementSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimaryPlacement" + }, + "WaitForPrimarySwapSafetyCheck": { + "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForPrimarySwapSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimarySwap" + }, + "WaitForReconfigurationSafetyCheck": { + "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + }, + { + "type": "object", + "description": "WaitForReconfigurationSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForReconfiguration" + }, + "LoadMetricReport": { + "type": "object", + "description": "Represents the load metric report which contains the time metric was reported, its name and value.", + "properties": { + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the UTC time when the load was reported." + }, + "Name": { + "type": "string", + "description": "The name of the load metric." + }, + "Value": { + "type": "string", + "format": "int32", + "description": "The value of the load metric." + } + } + }, + "PartitionLoadInformation": { + "type": "object", + "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition." + }, + "PrimaryLoadMetricReports": { + "type": "array", + "description": "Array of load reports from the primary replica for this partition.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + }, + "SecondaryLoadMetricReports": { + "type": "array", + "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + } + } + }, + "StatefulServiceReplicaInfo": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + }, + { + "type": "object", + "description": "StatefulServiceReplicaInfo", + "properties": { + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + } + ] + }, + "StatelessServiceInstanceInfo": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + }, + { + "type": "object", + "description": "StatelessServiceInstanceInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + } + ] + }, + "ClusterFabricCodeVersionString": { + "type": "string", + "description": "The ServiceFabric code version of the cluster." + }, + "ClusterFabricConfigVersionString": { + "type": "string", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "ClusterUpgradeDescriptionObject": { + "type": "object", + "description": "Represents a ServiceFabric cluster upgrade", + "properties": { + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + } + } + }, + "ClusterUpgradeHealthPolicyObject": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.", + "properties": { + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.", + "maximum": 100, + "minimum": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.", + "maximum": 100, + "minimum": 0 + } + } + }, + "ClusterUpgradeProgressObject": { + "type": "object", + "description": "Information about a cluster upgrade.", + "properties": { + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ClusterUpgradeDescriptionObject", + "description": "Represents a ServiceFabric cluster upgrade" + }, + "UpgradeDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDurationString", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainDurationString", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "$ref": "#/definitions/UpgradeStartTimeUTCString", + "description": "The start time of the upgrade in UTC." + }, + "FailureTimestampUtc": { + "$ref": "#/definitions/UpgradeFailureTimeUTCString", + "description": "The failure time of the upgrade in UTC." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailedUpgradeDomainProgressObject", + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure." + } + } + }, + "ClusterConfigurationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for a standalone cluster configuration upgrade.", + "properties": { + "ClusterConfig": { + "type": "string", + "description": "The cluster configuration." + }, + "HealthCheckRetryTimeout": { + "type": "string", + "format": "duration", + "description": "The length of time between attempts to perform a health checks if the application or cluster is not healthy.", + "default": "PT0H0M0S" + }, + "HealthCheckWaitDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.", + "default": "PT0H0M0S" + }, + "HealthCheckStableDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time that the application or cluster must remain healthy.", + "default": "PT0H0M0S" + }, + "UpgradeDomainTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The timeout for the upgrade domain.", + "default": "PT0H0M0S" + }, + "UpgradeTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The upgrade timeout.", + "default": "PT0H0M0S" + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "ApplicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "ClusterConfig" + ] + }, + "DeltaHealthEvaluationBool": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "FailedUpgradeDomainProgressObject": { + "type": "object", + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "UpgradeDomainDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UpgradeDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeFailureTimeUTCString": { + "type": "string", + "description": "The failure time of the upgrade in UTC." + }, + "UpgradeStartTimeUTCString": { + "type": "string", + "description": "The start time of the upgrade in UTC." + }, + "UpgradeOrchestrationServiceState": { + "type": "object", + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "properties": { + "ServiceState": { + "type": "string", + "description": "The state of Service Fabric Upgrade Orchestration Service." + } + } + }, + "UpgradeOrchestrationServiceStateSummary": { + "type": "object", + "description": "Service state summary of Service Fabric Upgrade Orchestration Service.", + "properties": { + "CurrentCodeVersion": { + "type": "string", + "description": "The current code version of the cluster." + }, + "CurrentManifestVersion": { + "type": "string", + "description": "The current manifest version of the cluster." + }, + "TargetCodeVersion": { + "type": "string", + "description": "The target code version of the cluster." + }, + "TargetManifestVersion": { + "type": "string", + "description": "The target manifest version of the cluster." + }, + "PendingUpgradeType": { + "type": "string", + "description": "The type of the pending upgrade of the cluster." + } + } + }, + "ApplicationTypeImageStorePath": { + "description": "Path description for the application package in the image store specified during the prior copy operation.", + "required": [ + "ApplicationTypeBuildPath" + ], + "properties": { + "ApplicationTypeBuildPath": { + "type": "string", + "description": "The relative image store path to the application package." + } + } + }, + "UnprovisionApplicationTypeDescriptionInfo": { + "type": "object", + "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.", + "required": [ + "ApplicationTypeVersion" + ], + "properties": { + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Async": { + "type": "boolean", + "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned." + } + } + }, + "CodePackageName": { + "type": "string", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageEntryPointStatistics": { + "type": "object", + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "LastExitCode": { + "type": "string", + "description": "The last exit code of the entry point." + }, + "LastActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when Service Fabric attempted to run the entry point." + }, + "LastExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running." + }, + "LastSuccessfulActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point ran successfully." + }, + "LastSuccessfulExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running gracefully." + }, + "ActivationCount": { + "type": "string", + "description": "Number of times the entry point has run." + }, + "ActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to run." + }, + "ContinuousActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to run." + }, + "ExitCount": { + "type": "string", + "description": "Number of times the entry point finished running." + }, + "ExitFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to exit gracefully." + }, + "ContinuousExitFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to exit gracefully." + } + } + }, + "DeployedCodePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedCodePackageInfo" + }, + "description": "List of deployed code package information." + }, + "DeployedCodePackageInfo": { + "type": "object", + "description": "Information about code package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package." + }, + "Version": { + "type": "string", + "description": "The version of the code package specified in service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostType": { + "$ref": "#/definitions/HostType", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest." + }, + "HostIsolationMode": { + "$ref": "#/definitions/HostIsolationMode", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "RunFrequencyInterval": { + "type": "string", + "description": "The interval at which code package is run. This is used for periodic code package." + }, + "SetupEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "MainEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + } + } + }, + "DeploymentStatus": { + "type": "string", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of the application or service package is not known or invalid. The value is 0." + }, + { + "value": "Downloading", + "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates the application or service package is being activated. The value is 2." + }, + { + "value": "Active", + "description": "Indicates the application or service package is active the node. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates the application or service package is being upgraded. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates the application or service package is being deactivated. The value is 5." + } + ] + } + }, + "EntryPointStatus": { + "type": "string", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.", + "enum": [ + "Invalid", + "Pending", + "Starting", + "Started", + "Stopping", + "Stopped" + ], + "x-ms-enum": { + "name": "EntryPointStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of entry point is not known or invalid. The value is 0." + }, + { + "value": "Pending", + "description": "Indicates the entry point is scheduled to be started. The value is 1." + }, + { + "value": "Starting", + "description": "Indicates the entry point is being started. The value is 2." + }, + { + "value": "Started", + "description": "Indicates the entry point was started successfully and is running. The value is 3." + }, + { + "value": "Stopping", + "description": "Indicates the entry point is being stopped. The value is 4." + }, + { + "value": "Stopped", + "description": "Indicates the entry point is not running. The value is 5." + } + ] + } + }, + "CodePackageEntryPoint": { + "type": "object", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "EntryPointLocation": { + "type": "string", + "description": "The location of entry point executable on the node." + }, + "ProcessId": { + "type": "string", + "description": "The process ID of the entry point." + }, + "RunAsUserName": { + "type": "string", + "description": "The user name under which entry point executable is run on the node." + }, + "CodePackageEntryPointStatistics": { + "$ref": "#/definitions/CodePackageEntryPointStatistics", + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "Status": { + "$ref": "#/definitions/EntryPointStatus", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node." + }, + "NextActivationTime": { + "type": "string", + "format": "date-time", + "description": "The time (in UTC) when the entry point executable will be run next." + }, + "InstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + } + } + }, + "Chaos": { + "type": "object", + "description": "Contains a description of Chaos.", + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "If Chaos is running, these are the parameters Chaos is running with." + }, + "Status": { + "$ref": "#/definitions/ChaosStatus", + "description": "Current status of the Chaos run." + }, + "ScheduleStatus": { + "$ref": "#/definitions/ChaosScheduleStatus", + "description": "Current status of the schedule." + } + } + }, + "ChaosStatus": { + "type": "string", + "description": "Current status of the Chaos run.", + "enum": [ + "Invalid", + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Running", + "description": "Indicates that Chaos is not stopped. The value is one." + }, + { + "value": "Stopped", + "description": "Indicates that Chaos is not scheduling further faults. The value is two." + } + ] + } + }, + "ChaosScheduleStatus": { + "type": "string", + "description": "Current status of the schedule.", + "enum": [ + "Invalid", + "Stopped", + "Active", + "Expired", + "Pending" + ], + "x-ms-enum": { + "name": "ChaosScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Stopped", + "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one." + }, + { + "value": "Active", + "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two." + }, + { + "value": "Expired", + "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three." + }, + { + "value": "Pending", + "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four." + } + ] + } + }, + "ChaosContextMap": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + }, + "ChaosContext": { + "type": "object", + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.", + "properties": { + "Map": { + "$ref": "#/definitions/ChaosContextMap", + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + } + } + }, + "ChaosParameters": { + "type": "object", + "description": "Defines all the parameters to configure a Chaos run.", + "properties": { + "TimeToRunInSeconds": { + "type": "string", + "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).", + "default": "4294967295" + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.", + "default": 60, + "minimum": 0, + "maximum": 4294967295 + }, + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.", + "default": 1, + "minimum": 0, + "maximum": 4294967295 + }, + "EnableMoveReplicaFaults": { + "type": "boolean", + "description": "Enables or disables the move primary and move secondary faults.", + "default": true + }, + "WaitTimeBetweenFaultsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.", + "default": 20, + "minimum": 0, + "maximum": 4294967295 + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.", + "default": 30, + "minimum": 0, + "maximum": 4294967295 + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check." + }, + "Context": { + "$ref": "#/definitions/ChaosContext", + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run." + }, + "ChaosTargetFilter": { + "$ref": "#/definitions/ChaosTargetFilter", + "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification." + } + } + }, + "ChaosParametersDictionaryItem": { + "type": "object", + "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs." + }, + "Value": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + }, + "ChaosEvent": { + "type": "object", + "discriminator": "Kind", + "description": "Represents an event generated during a Chaos run.", + "properties": { + "Kind": { + "$ref": "#/definitions/ChaosEventKind", + "description": "The kind of Chaos event." + }, + "TimeStampUtc": { + "type": "string", + "description": "The UTC timestamp when this Chaos event was generated.", + "format": "date-time" + } + }, + "required": [ + "Kind", + "TimeStampUtc" + ] + }, + "ChaosEventWrapper": { + "type": "object", + "description": "Wrapper object for Chaos event.", + "properties": { + "ChaosEvent": { + "$ref": "#/definitions/ChaosEvent", + "description": "Represents an event generated during a Chaos run." + } + } + }, + "ChaosEventKind": { + "type": "string", + "description": "The kind of Chaos event.", + "enum": [ + "Invalid", + "Started", + "ExecutingFaults", + "Waiting", + "ValidationFailed", + "TestError", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosEventKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Started", + "description": "Indicates a Chaos event that gets generated when Chaos is started." + }, + { + "value": "ExecutingFaults", + "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings." + }, + { + "value": "Waiting", + "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish." + }, + { + "value": "ValidationFailed", + "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds." + }, + { + "value": "TestError", + "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted." + }, + { + "value": "Stopped", + "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up." + } + ] + } + }, + "ChaosEventsSegment": { + "type": "object", + "description": "Contains the list of Chaos events and the continuation token to get the next segment.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "History": { + "$ref": "#/definitions/ChaosEventHistory", + "description": "List of Chaos events that meet the user-supplied criteria." + } + } + }, + "ChaosScheduleDescription": { + "type": "object", + "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.", + "properties": { + "Version": { + "description": "The version number of the Schedule.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "Schedule": { + "$ref": "#/definitions/ChaosSchedule", + "description": "Defines the schedule used by Chaos." + } + } + }, + "ChaosSchedule": { + "type": "object", + "description": "Defines the schedule used by Chaos.", + "properties": { + "StartDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will start using this schedule.", + "default": "1601-01-01T00:00:00Z" + }, + "ExpiryDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will continue to use this schedule until.", + "default": "9999-12-31T23:59:59.999Z" + }, + "ChaosParametersDictionary": { + "type": "array", + "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.", + "items": { + "$ref": "#/definitions/ChaosParametersDictionaryItem" + } + }, + "Jobs": { + "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ChaosScheduleJob" + } + } + } + }, + "ChaosScheduleJob": { + "type": "object", + "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.", + "properties": { + "ChaosParameters": { + "type": "string", + "description": "A reference to which Chaos Parameters of the Chaos Schedule to use." + }, + "Days": { + "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek", + "description": "Defines the days of the week that a Chaos Schedule Job will run for." + }, + "Times": { + "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeRange" + } + } + } + }, + "ChaosScheduleJobActiveDaysOfWeek": { + "type": "object", + "description": "Defines the days of the week that a Chaos Schedule Job will run for.", + "properties": { + "Sunday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Sunday", + "default": false + }, + "Monday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Monday", + "default": false + }, + "Tuesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Tuesday", + "default": false + }, + "Wednesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Wednesday", + "default": false + }, + "Thursday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Thursday", + "default": false + }, + "Friday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Friday", + "default": false + }, + "Saturday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Saturday", + "default": false + } + } + }, + "TimeRange": { + "type": "object", + "description": "Defines a time range in a 24 hour day specified by a start and end time.", + "properties": { + "StartTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + }, + "EndTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + } + } + }, + "TimeOfDay": { + "type": "object", + "description": "Defines an hour and minute of the day specified in 24 hour time.", + "properties": { + "Hour": { + "type": "integer", + "format": "int32", + "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.", + "minimum": 0, + "maximum": 23 + }, + "Minute": { + "type": "integer", + "format": "int32", + "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.", + "minimum": 0, + "maximum": 59 + } + } + }, + "ExecutingFaultsChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.", + "x-ms-discriminator-value": "ExecutingFaults", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "ExecutingFaultsChaosEvent", + "properties": { + "Faults": { + "type": "array", + "description": "List of string description of the faults that Chaos decided to execute in an iteration.", + "items": { + "type": "string" + } + } + } + } + ] + }, + "StartedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is started.", + "x-ms-discriminator-value": "Started", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "StartedChaosEvent", + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + } + ] + }, + "StoppedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.", + "x-ms-discriminator-value": "Stopped", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "StoppedChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over." + } + } + } + ] + }, + "TestErrorChaosEvent": { + "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.", + "x-ms-discriminator-value": "TestError", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "TestErrorChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant." + } + } + } + ] + }, + "ValidationFailedChaosEvent": { + "description": "Chaos event corresponding to a failure during validation.", + "x-ms-discriminator-value": "ValidationFailed", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "ValidationFailedChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string." + } + } + } + ] + }, + "WaitingChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.", + "x-ms-discriminator-value": "Waiting", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + }, + { + "type": "object", + "description": "WaitingChaosEvent", + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade." + } + } + } + ] + }, + "ChaosEventHistory": { + "type": "array", + "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.", + "items": { + "$ref": "#/definitions/ChaosEventWrapper" + } + }, + "ChaosTargetFilter": { + "type": "object", + "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.", + "properties": { + "NodeTypeInclusionList": { + "type": "array", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "ApplicationInclusionList": { + "type": "array", + "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/ApplicationName" + } + } + } + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "ApplicationCapacityDescription": { + "type": "object", + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application", + "properties": { + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", + "minimum": 0 + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", + "minimum": 0, + "default": 0 + }, + "ApplicationMetrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationDescription": { + "type": "object", + "description": "Describes a Service Fabric application.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "ParameterList": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationCapacity": { + "$ref": "#/definitions/ApplicationCapacityDescription", + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application" + } + }, + "required": [ + "Name", + "TypeName", + "TypeVersion" + ] + }, + "ApplicationMetricDescription": { + "type": "object", + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "MaximumCapacity": { + "type": "integer", + "format": "int64", + "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity." + }, + "ReservationCapacity": { + "type": "integer", + "format": "int64", + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric." + }, + "TotalApplicationCapacity": { + "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ComposeDeploymentStatus": { + "type": "string", + "description": "The status of the compose deployment.", + "enum": [ + "Invalid", + "Provisioning", + "Creating", + "Ready", + "Unprovisioning", + "Deleting", + "Failed", + "Upgrading" + ], + "x-ms-enum": { + "name": "ComposeDeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the compose deployment status is invalid. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the compose deployment is being provisioned in background. The value is 1." + }, + { + "value": "Creating", + "description": "Indicates that the compose deployment is being created in background. The value is 2." + }, + { + "value": "Ready", + "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the compose deployment is being deleted in background. The value is 5." + }, + { + "value": "Failed", + "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6." + }, + { + "value": "Upgrading", + "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7." + } + ] + } + }, + "ComposeDeploymentStatusInfo": { + "type": "object", + "description": "Information about a Service Fabric compose deployment.", + "properties": { + "Name": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "Status": { + "$ref": "#/definitions/ComposeDeploymentStatus", + "description": "The status of the compose deployment." + }, + "StatusDetails": { + "description": "The status details of compose deployment including failure message.", + "type": "string" + } + } + }, + "ComposeDeploymentUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent", + "UpgradeKind" + ] + }, + "ComposeDeploymentUpgradeProgressInfo": { + "type": "object", + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/TargetDeploymentName", + "description": "The name of the target deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "UpgradeState": { + "$ref": "#/definitions/ComposeDeploymentUpgradeState", + "description": "The state of the compose deployment upgrade." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDuration": { + "$ref": "#/definitions/UpgradeDuration", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "CurrentUpgradeDomainDuration": { + "$ref": "#/definitions/CurrentUpgradeDomainDuration", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "ApplicationUnhealthyEvaluations": { + "$ref": "#/definitions/ApplicationUnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "ApplicationUpgradeStatusDetails": { + "type": "string", + "description": "Additional details of application upgrade including failure message." + } + } + }, + "ComposeDeploymentUpgradeState": { + "type": "string", + "description": "The state of the compose deployment upgrade.", + "enum": [ + "Invalid", + "ProvisioningTarget", + "RollingForwardInProgress", + "RollingForwardPending", + "UnprovisioningCurrent", + "RollingForwardCompleted", + "RollingBackInProgress", + "UnprovisioningTarget", + "RollingBackCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "ComposeDeploymentUpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "ProvisioningTarget", + "description": "The upgrade is in the progress of provisioning target application type version. The value is 1." + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2." + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "UnprovisioningCurrent", + "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4." + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6." + }, + { + "value": "UnprovisioningTarget", + "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7." + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 8." + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9." + } + ] + } + }, + "PagedComposeDeploymentStatusInfoList": { + "type": "object", + "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of compose deployment status information.", + "items": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + } + } + }, + "CreateComposeDeploymentDescription": { + "type": "object", + "description": "Defines description for creating a Service Fabric compose deployment.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent" + ] + }, + "RegistryCredential": { + "type": "object", + "description": "Credential information to connect to container registry.", + "properties": { + "RegistryUserName": { + "type": "string", + "description": "The user name to connect to container registry." + }, + "RegistryPassword": { + "type": "string", + "description": "The password for supplied username to connect to container registry." + }, + "PasswordEncrypted": { + "type": "boolean", + "description": "Indicates that supplied container registry password is encrypted." + } + } + }, + "DeployedServicePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageInfo" + }, + "description": "List of deployed service package information." + }, + "DeployedServicePackageInfo": { + "type": "object", + "description": "Information about service package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service package as specified in the service manifest." + }, + "Version": { + "type": "string", + "description": "The version of the service package specified in service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeploymentName": { + "type": "string", + "description": "The name of the deployment." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Invalid", + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" + } + ] + } + }, + "ServiceCorrelationDescription": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "An invalid correlation scheme. Cannot be used. The value is zero." + }, + { + "value": "Affinity", + "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." + }, + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." + } + ] + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "SecondaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "DefaultLoad": { + "type": "integer", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServicePackageActivationMode": { + "type": "string", + "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero." + }, + { + "value": "ExclusiveProcess", + "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1." + } + ] + } + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "PartitionSchemeDescription": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "Count", + "Names" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "Names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." + } + } + }, + "SingletonPartitionSchemeDescription": { + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "UniformInt64RangePartitionSchemeDescription": { + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "Count", + "LowKey", + "HighKey" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "LowKey": { + "type": "string", + "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions." + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions." + } + } + }, + "ServiceDescription": { + "type": "object", + "discriminator": "ServiceKind", + "description": "A ServiceDescription contains all of the information necessary to create a service.", + "required": [ + "ServiceKind", + "ServiceName", + "ServiceTypeName", + "PartitionDescription" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created." + }, + "PartitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription", + "description": "The partition description as an object." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "ServiceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean", + "description": "Indicates if the DefaultMoveCost property is specified." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceDescription": { + "description": "Describes a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + }, + { + "type": "object", + "description": "StatefulServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "required": [ + "TargetReplicaSetSize", + "MinReplicaSetSize", + "HasPersistedState" + ], + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "Flags": { + "type": "integer", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceDescription": { + "description": "Describes a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + }, + { + "type": "object", + "description": "StatelessServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "InstanceCount" + ], + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ReplicatorQueueStatus": { + "type": "object", + "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.", + "properties": { + "QueueUtilizationPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full." + }, + "QueueMemorySize": { + "type": "string", + "description": "Represents the virtual memory consumed by the queue in bytes." + }, + "FirstSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue." + }, + "CompletedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state." + }, + "CommittedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary." + }, + "LastSequenceNumber": { + "type": "string", + "description": "Represents the latest sequence number of the operation that is available in the queue." + } + } + }, + "ReplicatorStatus": { + "type": "object", + "discriminator": "Kind", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + } + } + }, + "PrimaryReplicatorStatus": { + "x-ms-discriminator-value": "Primary", + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Status of the primary replicator.", + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the primary replicator." + }, + "RemoteReplicators": { + "$ref": "#/definitions/RemoteReplicatorStatusList", + "description": "The status of all the active and idle secondary replicators that the primary is aware of." + } + } + } + ] + }, + "SecondaryReplicatorStatus": { + "type": "object", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + }, + { + "type": "object", + "description": "Represents a base class for secondary replicator status.", + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the secondary replicator." + }, + "LastReplicationOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received." + }, + "IsInBuild": { + "type": "boolean", + "description": "Value that indicates whether the replica is currently being built." + }, + "CopyQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the copy queue on the secondary replicator." + }, + "LastCopyOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received." + }, + "LastAcknowledgementSentTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent." + } + } + } + ] + }, + "SecondaryActiveReplicatorStatus": { + "x-ms-discriminator-value": "ActiveSecondary", + "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + }, + { + "type": "object" + } + ] + }, + "SecondaryIdleReplicatorStatus": { + "x-ms-discriminator-value": "IdleSecondary", + "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + }, + { + "type": "object" + } + ] + }, + "RemoteReplicatorStatus": { + "type": "object", + "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Represents the replica ID of the remote secondary replicator." + }, + "LastAcknowledgementProcessedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed." + }, + "LastReceivedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has received from the primary." + }, + "LastAppliedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has applied to its state." + }, + "IsInBuild": { + "type": "boolean", + "description": "A value that indicates whether the secondary replica is in the process of being built." + }, + "LastReceivedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations." + }, + "LastAppliedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete." + }, + "RemoteReplicatorAcknowledgementStatus": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus", + "description": "Represents the acknowledgment status for the remote secondary replicator." + } + } + }, + "RemoteReplicatorStatusList": { + "type": "array", + "items": { + "$ref": "#/definitions/RemoteReplicatorStatus" + }, + "description": "List of remote replicator status" + }, + "RemoteReplicatorAcknowledgementStatus": { + "type": "object", + "description": "Provides details about the remote replicators from the primary replicator's point of view.", + "properties": { + "ReplicationStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the replication stream data." + }, + "CopyStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the copy stream data." + } + } + }, + "RemoteReplicatorAcknowledgementDetail": { + "type": "object", + "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.", + "properties": { + "AverageReceiveDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to receive an operation." + }, + "AverageApplyDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk." + }, + "NotReceivedCount": { + "type": "string", + "description": "Represents the number of operations not yet received by a remote replicator." + }, + "ReceivedAndNotAppliedCount": { + "type": "string", + "description": "Represents the number of operations received and not yet applied by a remote replicator." + } + } + }, + "DeployedServiceReplicaDetailInfo": { + "type": "object", + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Full hierarchical name of the service in URI format starting with `fabric:`." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "CurrentServiceOperation": { + "$ref": "#/definitions/ServiceOperationName", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance." + }, + "CurrentServiceOperationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The start time of the current service operation in UTC format." + }, + "ReportedLoad": { + "$ref": "#/definitions/LoadMetricReportInfoList", + "description": "List of load reported by replica." + } + } + }, + "DeployedStatefulServiceReplicaDetailInfo": { + "description": "Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatefulServiceReplicaDetailInfo", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "CurrentReplicatorOperation": { + "$ref": "#/definitions/ReplicatorOperationName", + "description": "Specifies the operation currently being executed by the Replicator." + }, + "ReadStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "WriteStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "ReplicatorStatus": { + "$ref": "#/definitions/ReplicatorStatus", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc." + }, + "ReplicaStatus": { + "$ref": "#/definitions/KeyValueStoreReplicaStatus", + "description": "Key value store related information for the replica." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo", + "description": "Information about a stateful service replica deployed on a node." + } + } + } + ] + }, + "DeployedStatelessServiceInstanceDetailInfo": { + "description": "Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + }, + { + "type": "object", + "description": "DeployedStatelessServiceInstanceDetailInfo", + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo", + "description": "Information about a stateless service instance deployed on a node." + } + } + } + ] + }, + "FabricReplicaStatus": { + "type": "string", + "description": "Specifies the status of the replica.", + "enum": [ + "Invalid", + "Down", + "Up" + ], + "x-ms-enum": { + "name": "FabricReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Down", + "description": "Indicates that the replica is down." + }, + { + "value": "Up", + "description": "Indicates that the replica is up." + } + ] + } + }, + "LoadMetricReportInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadMetricReportInfo" + }, + "description": "List of load reported by replica." + }, + "LoadMetricReportInfo": { + "type": "object", + "description": "Information about load reported by replica.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "Value": { + "type": "integer", + "format": "int32", + "description": "The value of the load for the metric.." + }, + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC time when the load is reported." + } + } + }, + "PartitionAccessStatus": { + "type": "string", + "description": "Specifies the access status of the partition.", + "enum": [ + "Invalid", + "Granted", + "ReconfigurationPending", + "NotPrimary", + "NoWriteQuorum" + ], + "x-ms-enum": { + "name": "PartitionAccessStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Granted", + "description": "Indicates that the read or write operation access is granted and the operation is allowed." + }, + { + "value": "ReconfigurationPending", + "description": "Indicates that the client should try again later, because a reconfiguration is in progress." + }, + { + "value": "NotPrimary", + "description": "Indicates that this client request was received by a replica that is not a Primary replica." + }, + { + "value": "NoWriteQuorum", + "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted." + } + ] + } + }, + "ReplicatorOperationName": { + "type": "string", + "description": "Specifies the operation currently being executed by the Replicator.", + "enum": [ + "Invalid", + "None", + "Open", + "ChangeRole", + "UpdateEpoch", + "Close", + "Abort", + "OnDataLoss", + "WaitForCatchup", + "Build" + ], + "x-ms-enum": { + "name": "ReplicatorOperationName", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Default value if the replicator is not yet ready." + }, + { + "value": "None", + "description": "Replicator is not running any operation from Service Fabric perspective." + }, + { + "value": "Open", + "description": "Replicator is opening." + }, + { + "value": "ChangeRole", + "description": "Replicator is in the process of changing its role." + }, + { + "value": "UpdateEpoch", + "description": "Due to a change in the replica set, replicator is being updated with its Epoch." + }, + { + "value": "Close", + "description": "Replicator is closing." + }, + { + "value": "Abort", + "description": "Replicator is being aborted." + }, + { + "value": "OnDataLoss", + "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source." + }, + { + "value": "WaitForCatchup", + "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state." + }, + { + "value": "Build", + "description": "Replicator is in the process of building one or more replicas." + } + ] + } + }, + "ServiceOperationName": { + "type": "string", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.", + "enum": [ + "Unknown", + "None", + "Open", + "ChangeRole", + "Close", + "Abort" + ], + "x-ms-enum": { + "name": "ServiceOperationName", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Reserved for future use." + }, + { + "value": "None", + "description": "The service replica or instance is not going through any life-cycle changes." + }, + { + "value": "Open", + "description": "The service replica or instance is being opened." + }, + { + "value": "ChangeRole", + "description": "The service replica is changing roles." + }, + { + "value": "Close", + "description": "The service replica or instance is being closed." + }, + { + "value": "Abort", + "description": "The service replica or instance is being aborted." + } + ] + } + }, + "ReplicaKind": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Invalid", + "KeyValueStore" + ], + "x-ms-enum": { + "name": "ReplicaKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Represents an invalid replica kind. The value is zero." + }, + { + "value": "KeyValueStore", + "description": "Represents a key value store replica. The value is 1" + } + ] + } + }, + "ReplicaStatusBase": { + "type": "object", + "discriminator": "Kind", + "description": "Information about the replica.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaKind", + "description": "The role of a replica of a stateful service." + } + } + }, + "KeyValueStoreReplicaStatus": { + "description": "Key value store related information for the replica.", + "x-ms-discriminator-value": "KeyValueStore", + "allOf": [ + { + "$ref": "#/definitions/ReplicaStatusBase" + }, + { + "type": "object", + "description": "KeyValueStoreReplicaStatus", + "properties": { + "DatabaseRowCountEstimate": { + "type": "string", + "description": "Value indicating the estimated number of rows in the underlying database." + }, + "DatabaseLogicalSizeEstimate": { + "type": "string", + "description": "Value indicating the estimated size of the underlying database." + }, + "CopyNotificationCurrentKeyFilter": { + "type": "string", + "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback." + }, + "CopyNotificationCurrentProgress": { + "type": "string", + "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback." + }, + "StatusDetails": { + "type": "string", + "description": "Value indicating the current status details of the replica." + } + } + } + ] + }, + "ServiceUpdateDescription": { + "type": "object", + "discriminator": "ServiceKind", + "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "Flags": { + "type": "string", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceUpdateDescription": { + "description": "Describes an update for a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + }, + { + "type": "object", + "description": "StatefulServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "string", + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "string", + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceUpdateDescription": { + "description": "Describes an update for a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + }, + { + "type": "object", + "description": "StatelessServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ImageStoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileVersion": { + "type": "object", + "description": "Information about the version of image store file.", + "properties": { + "VersionNumber": { + "type": "string", + "description": "The current image store version number for the file is used in image store for checking whether it need to be updated." + }, + "EpochDataLossNumber": { + "type": "string", + "description": "The epoch data loss number of image store replica when this file entry was updated or created." + }, + "EpochConfigurationNumber": { + "type": "string", + "description": "The epoch configuration version number of the image store replica when this file entry was created or updated." + } + } + }, + "FileInfo": { + "type": "object", + "description": "Information about a image store file.", + "properties": { + "FileSize": { + "type": "string", + "description": "The size of file in bytes." + }, + "FileVersion": { + "$ref": "#/definitions/FileVersion", + "description": "Information about the version of image store file." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the image store file was last modified." + }, + "StoreRelativePath": { + "type": "string", + "description": "The file path relative to the image store root path." + } + } + }, + "FolderInfo": { + "type": "object", + "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.", + "properties": { + "StoreRelativePath": { + "$ref": "#/definitions/ImageStoreRelativePath", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileCount": { + "type": "string", + "description": "The number of files from within the image store folder." + } + } + }, + "ImageStoreContent": { + "type": "object", + "description": "Information about the image store content.", + "properties": { + "StoreFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/FileInfo" + }, + "description": "The list of image store file info objects represents files found under the given image store relative path." + }, + "StoreFolders": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderInfo" + }, + "description": "The list of image store folder info objects represents subfolders found under the given image store relative path." + } + } + }, + "ImageStoreCopyDescription": { + "type": "object", + "description": "Information about how to copy image store content from one image store relative path to another image store relative path.", + "required": [ + "RemoteSource", + "RemoteDestination" + ], + "properties": { + "RemoteSource": { + "type": "string", + "description": "The relative path of source image store content to be copied from." + }, + "RemoteDestination": { + "type": "string", + "description": "The relative path of destination image store content to be copied to." + }, + "SkipFiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of the file names to be skipped for copying." + }, + "CheckMarkFile": { + "type": "boolean", + "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped." + } + } + }, + "InstanceId": { + "type": "string", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "CodePackageInstanceId": { + "type": "string", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + }, + "HostIsolationMode": { + "type": "string", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.", + "enum": [ + "None", + "Process", + "HyperV" + ], + "x-ms-enum": { + "name": "HostIsolationMode", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0." + }, + { + "value": "Process", + "description": "This is the default isolation mode for a ContainerHost. The value is 1." + }, + { + "value": "HyperV", + "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2." + } + ] + } + }, + "HostType": { + "type": "string", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.", + "enum": [ + "Invalid", + "ExeHost", + "ContainerHost" + ], + "x-ms-enum": { + "name": "HostType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of host is not known or invalid. The value is 0." + }, + { + "value": "ExeHost", + "description": "Indicates the host is an executable. The value is 1." + }, + { + "value": "ContainerHost", + "description": "Indicates the host is a container. The value is 2." + } + ] + } + }, + "RestartDeployedCodePackageDescription": { + "type": "object", + "description": "Defines description for restarting a deployed code package on Service Fabric node.", + "required": [ + "ServiceManifestName", + "CodePackageName", + "CodePackageInstanceId" + ], + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageInstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package." + } + } + }, + "DeployedServiceTypeInfo": { + "type": "object", + "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.", + "properties": { + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that registered the service type." + }, + "Status": { + "$ref": "#/definitions/ServiceTypeRegistrationStatus", + "description": "The status of the service type registration on the node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeployedServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceTypeInfo" + }, + "description": "List of information about service type deployed on a node." + }, + "ServiceTypeRegistrationStatus": { + "type": "string", + "description": "The status of the service type registration on the node.", + "enum": [ + "Invalid", + "Disabled", + "Enabled", + "Registered" + ], + "x-ms-enum": { + "name": "ServiceTypeRegistrationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Disabled", + "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1." + }, + { + "value": "Enabled", + "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2." + }, + { + "value": "Registered", + "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3." + } + ] + } + }, + "ServiceEndpointRole": { + "type": "string", + "description": "The role of the replica where the endpoint is reported.", + "enum": [ + "Invalid", + "Stateless", + "StatefulPrimary", + "StatefulSecondary" + ], + "x-ms-enum": { + "name": "ServiceEndpointRole", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Indicates that the service endpoint is of a stateless service. The value is 1." + }, + { + "value": "StatefulPrimary", + "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2." + }, + { + "value": "StatefulSecondary", + "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3." + } + ] + } + }, + "ResolvedServiceEndpoint": { + "type": "object", + "description": "Endpoint of a resolved service partition.", + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceEndpointRole", + "description": "The role of the replica where the endpoint is reported." + }, + "Address": { + "type": "string", + "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener." + } + } + }, + "ResolvedServicePartition": { + "type": "object", + "description": "Information about a service partition and its associated endpoints.", + "required": [ + "Name", + "PartitionInformation", + "Endpoints", + "Version" + ], + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "A representation of the resolved partition." + }, + "Endpoints": { + "$ref": "#/definitions/ResolvedServiceEndpointList", + "description": "List of resolved service endpoints of a service partition." + }, + "Version": { + "type": "string", + "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter." + } + } + }, + "ResolvedServiceEndpointList": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolvedServiceEndpoint" + }, + "description": "List of resolved service endpoints of a service partition." + }, + "InvokeDataLossResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "InvokeQuorumLossResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "NodeResult": { + "type": "object", + "description": "Contains information about a node that was targeted by a user-induced operation.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "The node instance id." + } + } + }, + "NodeTransitionProgress": { + "type": "object", + "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "NodeTransitionResult": { + "$ref": "#/definitions/NodeTransitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "NodeTransitionResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "NodeResult": { + "$ref": "#/definitions/NodeResult", + "description": "Contains information about a node that was targeted by a user-induced operation." + } + } + }, + "OperationId": { + "type": "string", + "format": "uuid", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "OperationState": { + "type": "string", + "description": "The state of the operation.", + "enum": [ + "Invalid", + "Running", + "RollingBack", + "Completed", + "Faulted", + "Cancelled", + "ForceCancelled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "Running", + "description": "The operation is in progress." + }, + { + "value": "RollingBack", + "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command." + }, + { + "value": "Completed", + "description": "The operation has completed successfully and is no longer running." + }, + { + "value": "Faulted", + "description": "The operation has failed and is no longer running." + }, + { + "value": "Cancelled", + "description": "The operation was cancelled by the user using CancelOperation, and is no longer running." + }, + { + "value": "ForceCancelled", + "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details." + } + ] + } + }, + "OperationStatus": { + "type": "object", + "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.", + "properties": { + "OperationId": { + "$ref": "#/definitions/OperationId", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "Type": { + "$ref": "#/definitions/OperationType", + "description": "The type of the operation." + } + } + }, + "OperationStatusList": { + "type": "array", + "description": "A list of OperationStatus objects.", + "items": { + "$ref": "#/definitions/OperationStatus" + } + }, + "OperationType": { + "type": "string", + "description": "The type of the operation.", + "enum": [ + "Invalid", + "PartitionDataLoss", + "PartitionQuorumLoss", + "PartitionRestart", + "NodeTransition" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "PartitionDataLoss", + "description": "An operation started using the StartDataLoss API." + }, + { + "value": "PartitionQuorumLoss", + "description": "An operation started using the StartQuorumLoss API." + }, + { + "value": "PartitionRestart", + "description": "An operation started using the StartPartitionRestart API." + }, + { + "value": "NodeTransition", + "description": "An operation started using the StartNodeTransition API." + } + ] + } + }, + "PartitionDataLossProgress": { + "type": "object", + "description": "Information about a partition data loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeDataLossResult": { + "$ref": "#/definitions/InvokeDataLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionQuorumLossProgress": { + "type": "object", + "description": "Information about a partition quorum loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeQuorumLossResult": { + "$ref": "#/definitions/InvokeQuorumLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionRestartProgress": { + "type": "object", + "description": "Information about a partition restart user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "RestartPartitionResult": { + "$ref": "#/definitions/RestartPartitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "RestartPartitionResult": { + "type": "object", + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "SelectedPartition": { + "type": "object", + "description": "This class returns information about the partition that the user-induced operation acted upon.", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service the partition belongs to." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "DeployServicePackageToNodeDescription": { + "type": "object", + "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.", + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest whose packages need to be downloaded." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "PackageSharingPolicy": { + "$ref": "#/definitions/PackageSharingPolicyInfoList", + "description": "List of package sharing policy information." + } + }, + "required": [ + "ServiceManifestName", + "ApplicationTypeName", + "ApplicationTypeVersion", + "NodeName" + ] + }, + "PackageSharingPolicyInfo": { + "type": "object", + "description": "Represents a policy for the package sharing.", + "properties": { + "SharedPackageName": { + "type": "string", + "description": "The name of code, configuration or data package that should be shared." + }, + "PackageSharingScope": { + "$ref": "#/definitions/PackageSharingPolicyScope", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation." + } + } + }, + "PackageSharingPolicyInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/PackageSharingPolicyInfo" + }, + "description": "List of package sharing policy information." + }, + "PackageSharingPolicyScope": { + "type": "string", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.", + "enum": [ + "None", + "All", + "Code", + "Config", + "Data" + ], + "x-ms-enum": { + "name": "PackageSharingPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No package sharing policy scope. The value is 0." + }, + { + "value": "All", + "description": "Share all code, config and data packages from corresponding service manifest. The value is 1." + }, + { + "value": "Code", + "description": "Share all code packages from corresponding service manifest. The value is 2." + }, + { + "value": "Config", + "description": "Share all config packages from corresponding service manifest. The value is 3." + }, + { + "value": "Data", + "description": "Share all data packages from corresponding service manifest. The value is 4." + } + ] + } + }, + "ResumeApplicationUpgradeDescription": { + "type": "object", + "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain in which to resume the upgrade." + } + }, + "required": [ + "UpgradeDomainName" + ] + }, + "ApplicationUpgradeUpdateDescription": { + "type": "object", + "description": "Describes the parameters for updating an ongoing application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + } + }, + "required": [ + "Name", + "UpgradeKind" + ] + }, + "RollingUpgradeUpdateDescription": { + "type": "object", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster.", + "properties": { + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "ReplicaSetCheckTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + }, + "required": [ + "RollingUpgradeMode" + ] + }, + "NameDescription": { + "type": "object", + "description": "Describes a Service Fabric name.", + "properties": { + "Name": { + "$ref": "#/definitions/FabricName", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + } + }, + "required": [ + "Name" + ] + }, + "FabricName": { + "type": "string", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + }, + "PagedSubNameInfoList": { + "type": "object", + "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "SubNames": { + "type": "array", + "description": "List of the child names.", + "items": { + "$ref": "#/definitions/FabricName" + } + } + } + }, + "PropertyValueKind": { + "type": "string", + "description": "The kind of property, determined by the type of data. Following are the possible values.", + "enum": [ + "Invalid", + "Binary", + "Int64", + "Double", + "String", + "Guid" + ], + "x-ms-enum": { + "name": "PropertyValueKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Binary", + "description": "The data inside the property is a binary blob. The value is 1." + }, + { + "value": "Int64", + "description": "The data inside the property is an int64. The value is 2." + }, + { + "value": "Double", + "description": "The data inside the property is a double. The value is 3." + }, + { + "value": "String", + "description": "The data inside the property is a string. The value is 4." + }, + { + "value": "Guid", + "description": "The data inside the property is a guid. The value is 5." + } + ] + } + }, + "PropertyValue": { + "type": "object", + "discriminator": "Kind", + "description": "Describes a Service Fabric property value.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "BinaryPropertyValue": { + "description": "Describes a Service Fabric property value of type Binary.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "BinaryPropertyValue" + } + ], + "x-ms-discriminator-value": "Binary", + "required": [ + "Data" + ], + "properties": { + "Data": { + "$ref": "#/definitions/ByteArray", + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255." + } + } + }, + "Int64PropertyValue": { + "description": "Describes a Service Fabric property value of type Int64.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "Int64PropertyValue" + } + ], + "x-ms-discriminator-value": "Int64", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "DoublePropertyValue": { + "description": "Describes a Service Fabric property value of type Double.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "DoublePropertyValue" + } + ], + "x-ms-discriminator-value": "Double", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "number", + "format": "double", + "description": "The data of the property value." + } + } + }, + "StringPropertyValue": { + "description": "Describes a Service Fabric property value of type String.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "StringPropertyValue" + } + ], + "x-ms-discriminator-value": "String", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "GuidPropertyValue": { + "description": "Describes a Service Fabric property value of type Guid.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + }, + { + "type": "object", + "description": "GuidPropertyValue" + } + ], + "x-ms-discriminator-value": "Guid", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "format": "uuid", + "description": "The data of the property value." + } + } + }, + "PropertyInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Information about a Service Fabric property.", + "properties": { + "Name": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "Metadata": { + "$ref": "#/definitions/PropertyMetadata", + "description": "The metadata associated with a property, including the property's name." + } + }, + "required": [ + "Name", + "Metadata" + ] + }, + "PagedPropertyInfoList": { + "type": "object", + "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "Properties": { + "type": "array", + "description": "List of property information.", + "items": { + "$ref": "#/definitions/PropertyInfo" + } + } + } + }, + "PropertyDescription": { + "type": "object", + "description": "Description of a Service Fabric property.", + "properties": { + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + } + }, + "required": [ + "PropertyName", + "Value" + ] + }, + "PropertyName": { + "type": "string", + "description": "The name of the Service Fabric property." + }, + "PropertyMetadata": { + "type": "object", + "description": "The metadata associated with a property, including the property's name.", + "properties": { + "TypeId": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID." + }, + "Parent": { + "$ref": "#/definitions/FabricName", + "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists." + }, + "SizeInBytes": { + "type": "integer", + "description": "The length of the serialized property value." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated." + }, + "SequenceNumber": { + "type": "string", + "description": "The version of the property. Every time a property is modified, its sequence number is increased." + } + } + }, + "PropertyCustomTypeId": { + "type": "string", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + }, + "PropertyBatchDescriptionList": { + "type": "object", + "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.", + "properties": { + "Operations": { + "type": "array", + "items": { + "$ref": "#/definitions/PropertyBatchOperation" + }, + "description": "A list of the property batch operations to be executed." + } + } + }, + "PropertyBatchOperationKind": { + "type": "string", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.", + "enum": [ + "Invalid", + "Put", + "Get", + "CheckExists", + "CheckSequence", + "Delete", + "CheckValue" + ], + "x-ms-enum": { + "name": "PropertyBatchOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Put", + "description": "The operation will create or edit a property. The value is 1." + }, + { + "value": "Get", + "description": "The operation will get a property. The value is 2." + }, + { + "value": "CheckExists", + "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3." + }, + { + "value": "CheckSequence", + "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4." + }, + { + "value": "Delete", + "description": "The operation will delete a property. The value is 5." + }, + { + "value": "CheckValue", + "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7." + } + ] + } + }, + "PropertyBatchOperation": { + "type": "object", + "discriminator": "Kind", + "description": "Represents the base type for property operations that can be put into a batch and submitted.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchOperationKind", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values." + }, + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + } + }, + "required": [ + "Kind", + "PropertyName" + ] + }, + "CheckExistsPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckExistsPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckExists", + "properties": { + "Exists": { + "type": "boolean", + "description": "Whether or not the property should exist for the operation to pass." + } + }, + "required": [ + "Exists" + ] + }, + "CheckSequencePropertyBatchOperation": { + "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckSequencePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckSequence", + "properties": { + "SequenceNumber": { + "type": "string", + "description": "The expected sequence number." + } + }, + "required": [ + "SequenceNumber" + ] + }, + "CheckValuePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "CheckValuePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckValue", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "The expected property value." + } + }, + "required": [ + "Value" + ] + }, + "DeletePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "DeletePropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "GetPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "GetPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Get", + "properties": { + "IncludeValue": { + "type": "boolean", + "default": false, + "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata." + } + } + }, + "PutPropertyBatchOperation": { + "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + }, + { + "type": "object", + "description": "PutPropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Put", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + } + }, + "required": [ + "Value" + ] + }, + "PropertyBatchInfoKind": { + "type": "string", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.", + "enum": [ + "Invalid", + "Successful", + "Failed" + ], + "x-ms-enum": { + "name": "PropertyBatchInfoKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Successful", + "description": "The property batch succeeded." + }, + { + "value": "Failed", + "description": "The property batch failed." + } + ] + } + }, + "PropertyBatchInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Information about the results of a property batch.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchInfoKind", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "SuccessfulPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + }, + { + "type": "object", + "description": "SuccessfulPropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Successful", + "properties": { + "Properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PropertyInfo" + }, + "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map." + } + } + }, + "FailedPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + }, + { + "type": "object", + "description": "FailedPropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Failed", + "properties": { + "ErrorMessage": { + "type": "string", + "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch." + }, + "OperationIndex": { + "type": "integer", + "description": "The index of the unsuccessful operation in the property batch." + } + } + }, + "EntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Node", + "Partition", + "Service", + "Application", + "Replica", + "DeployedApplication", + "DeployedServicePackage", + "Cluster" + ], + "x-ms-enum": { + "name": "EntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Node", + "description": "Indicates the entity is a Service Fabric node. The value is 1." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition. The value is 2." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service. The value is 3." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application. The value is 4." + }, + { + "value": "Replica", + "description": "Indicates the entity is a Service Fabric replica. The value is 5." + }, + { + "value": "DeployedApplication", + "description": "Indicates the entity is a Service Fabric deployed application. The value is 6." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7." + }, + { + "value": "Cluster", + "description": "Indicates the entity is a Service Fabric cluster. The value is 8." + } + ] + } + }, + "HealthStateCount": { + "type": "object", + "description": "Represents information about how many health entities are in Ok, Warning and Error health state.", + "properties": { + "OkCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Ok.", + "minimum": 0 + }, + "WarningCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Warning.", + "minimum": 0 + }, + "ErrorCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Error.", + "minimum": 0 + } + } + }, + "EntityKindHealthStateCount": { + "type": "object", + "description": "Represents health state count for entities of the specified entity kind.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/EntityKind", + "description": "The entity kind for which health states are evaluated." + }, + "HealthStateCount": { + "$ref": "#/definitions/HealthStateCount", + "description": "The health state count for the entities of the specified kind." + } + } + }, + "HealthStatistics": { + "type": "object", + "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.", + "properties": { + "HealthStateCountList": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityKindHealthStateCount" + }, + "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state." + } + } + }, + "BackupPolicyDescription": { + "type": "object", + "description": "Describes a backup policy for configuring periodic backup.", + "required": [ + "Name", + "AutoRestoreOnDataLoss", + "Schedule", + "MaxIncrementalBackups", + "Storage" + ], + "properties": { + "Name": { + "type": "string", + "description": "The unique name identifying this backup policy." + }, + "AutoRestoreOnDataLoss": { + "type": "boolean", + "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event." + }, + "MaxIncrementalBackups": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit." + }, + "Schedule": { + "$ref": "#/definitions/BackupScheduleDescription", + "description": "Describes the backup schedule parameters." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the details of backup storage where to store the periodic backups." + } + } + }, + "PagedBackupPolicyDescriptionList": { + "type": "object", + "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "The list of backup policies information.", + "items": { + "$ref": "#/definitions/BackupPolicyDescription" + } + } + } + }, + "BackupStorageDescription": { + "type": "object", + "required": [ + "StorageKind" + ], + "discriminator": "StorageKind", + "properties": { + "StorageKind": { + "$ref": "#/definitions/BackupStorageKind", + "description": "The kind of backup storage, where backups are saved." + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name for this backup storage." + } + }, + "description": "Describes the parameters for the backup storage." + }, + "BackupStorageKind": { + "type": "string", + "description": "The kind of backup storage, where backups are saved.", + "enum": [ + "Invalid", + "FileShare", + "AzureBlobStore" + ], + "x-ms-enum": { + "name": "BackupStorageKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "FileShare", + "description": "Indicates file/ SMB share to be used as backup storage." + }, + { + "value": "AzureBlobStore", + "description": "Indicates Azure blob store to be used as backup storage." + } + ] + } + }, + "BackupScheduleDescription": { + "type": "object", + "description": "Describes the backup schedule parameters.", + "required": [ + "ScheduleKind" + ], + "discriminator": "ScheduleKind", + "properties": { + "ScheduleKind": { + "$ref": "#/definitions/BackupScheduleKind", + "description": "The kind of backup schedule, time based or frequency based." + } + } + }, + "BackupScheduleKind": { + "type": "string", + "description": "The kind of backup schedule, time based or frequency based.", + "enum": [ + "Invalid", + "TimeBased", + "FrequencyBased" + ], + "x-ms-enum": { + "name": "BackupScheduleKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "TimeBased", + "description": "Indicates a time-based backup schedule." + }, + { + "value": "FrequencyBased", + "description": "Indicates a frequency-based backup schedule." + } + ] + } + }, + "ApplicationBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Application backup configuration information.", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Service backup configuration info", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Service" + }, + "PagedBackupConfigurationInfoList": { + "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup configuration information.", + "items": { + "$ref": "#/definitions/BackupConfigurationInfo" + } + } + } + }, + "BackupPolicyScope": { + "type": "string", + "description": "Specifies the scope at which the backup policy is applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level." + }, + { + "value": "Service", + "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level." + }, + { + "value": "Application", + "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level." + } + ] + } + }, + "BackupSuspensionScope": { + "type": "string", + "description": "Specifies the scope at which the backup suspension was applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupSuspensionScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup suspension is applied at partition level." + }, + { + "value": "Service", + "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup." + }, + { + "value": "Application", + "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup." + } + ] + } + }, + "RestorePartitionDescription": { + "type": "object", + "description": "Specifies the parameters needed to trigger a restore of a specific partition.", + "required": [ + "BackupId", + "BackupLocation" + ], + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID." + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup relative to the backup storage specified/ configured." + }, + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Location of the backup from where the partition will be restored." + } + } + }, + "RestoreProgressInfo": { + "type": "object", + "description": "Describes the progress of a restore operation on a partition.", + "properties": { + "RestoreState": { + "$ref": "#/definitions/RestoreState", + "description": "Represents the current state of the partition restore operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "Timestamp when operation succeeded or failed." + }, + "RestoredEpoch": { + "$ref": "#/definitions/BackupEpoch", + "description": "Describes the epoch at which the partition is restored." + }, + "RestoredLsn": { + "type": "string", + "description": "Restored LSN." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing restore operation." + } + } + }, + "RestoreState": { + "type": "string", + "description": "Represents the current state of the partition restore operation.", + "enum": [ + "Invalid", + "Accepted", + "RestoreInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "RestoreState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Restore is yet to be triggered." + }, + { + "value": "RestoreInProgress", + "description": "Restore operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupPartitionDescription": { + "type": "object", + "description": "Describes the parameters for triggering partition's backup.", + "properties": { + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Specifies the details of the backup storage where to save the backup." + } + } + }, + "BackupInfo": { + "type": "object", + "description": "Represents a backup point which can be used to trigger a restore.", + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID ." + }, + "BackupChainId": { + "type": "string", + "format": "uuid", + "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups." + }, + "ApplicationName": { + "type": "string", + "description": "Name of the Service Fabric application this partition backup belongs to." + }, + "ServiceName": { + "type": "string", + "description": "Name of the Service Fabric service this partition backup belongs to." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition to which this backup belongs to" + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup, relative to the backup store." + }, + "BackupType": { + "$ref": "#/definitions/BackupType", + "description": "Describes the type of backup, whether its full or incremental." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/BackupEpoch", + "description": "Epoch of the last record in this backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "LSN of the last record in this backup." + }, + "CreationTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The date time when this backup was taken." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in getting backup point information." + } + } + }, + "PagedBackupInfoList": { + "type": "object", + "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup information.", + "items": { + "$ref": "#/definitions/BackupInfo" + } + } + } + }, + "BackupType": { + "type": "string", + "description": "Describes the type of backup, whether its full or incremental.", + "enum": [ + "Invalid", + "Full", + "Incremental" + ], + "x-ms-enum": { + "name": "BackupType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Full", + "description": "Indicates a full backup." + }, + { + "value": "Incremental", + "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups." + } + ] + } + }, + "AzureBlobBackupStorageDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "AzureBlobBackupStorageDescription" + } + ], + "x-ms-discriminator-value": "AzureBlobStore", + "required": [ + "ConnectionString", + "ContainerName" + ], + "properties": { + "ConnectionString": { + "type": "string", + "description": "The connection string to connect to the Azure blob store." + }, + "ContainerName": { + "type": "string", + "description": "The name of the container in the blob store to store and enumerate backups from." + } + }, + "description": "Describes the parameters for Azure blob store used for storing and enumerating backups." + }, + "FileShareBackupStorageDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + }, + { + "type": "object" + }, + { + "description": "FileShareBackupStorageDescription" + } + ], + "x-ms-discriminator-value": "FileShare", + "required": [ + "Path" + ], + "description": "Describes the parameters for file share storage used for storing or enumerating backups.", + "properties": { + "Path": { + "type": "string", + "description": "UNC path of the file share where to store or enumerate backups from." + }, + "PrimaryUserName": { + "type": "string", + "description": "Primary user name to access the file share." + }, + "PrimaryPassword": { + "type": "string", + "description": "Primary password to access the share location." + }, + "SecondaryUserName": { + "type": "string", + "description": "Secondary user name to access the file share." + }, + "SecondaryPassword": { + "type": "string", + "description": "Secondary password to access the share location" + } + } + }, + "FrequencyBasedBackupScheduleDescription": { + "type": "object", + "description": "Describes the frequency based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "FrequencyBasedBackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "FrequencyBased", + "required": [ + "Interval" + ], + "properties": { + "Interval": { + "type": "string", + "format": "duration", + "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy." + } + } + }, + "TimeBasedBackupScheduleDescription": { + "type": "object", + "description": "Describes the time based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + }, + { + "type": "object" + }, + { + "description": "TimeBasedBackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "TimeBased", + "required": [ + "ScheduleFrequencyType", + "RunTimes" + ], + "properties": { + "ScheduleFrequencyType": { + "$ref": "#/definitions/BackupScheduleFrequencyType", + "description": "Describes the frequency with which to run the time based backup schedule." + }, + "RunDays": { + "$ref": "#/definitions/DayOfWeekList", + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "RunTimes": { + "$ref": "#/definitions/TimeList", + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + } + } + }, + "BackupScheduleFrequencyType": { + "type": "string", + "description": "Describes the frequency with which to run the time based backup schedule.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "x-ms-enum": { + "name": "BackupScheduleFrequencyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Daily", + "description": "Indicates that the time based backup schedule is repeated at a daily frequency." + }, + { + "value": "Weekly", + "description": "Indicates that the time based backup schedule is repeated at a weekly frequency." + } + ] + } + }, + "TimeList": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + }, + "DayOfWeekList": { + "type": "array", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "DayOfWeek": { + "type": "string", + "description": "Describes the days in a week.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true, + "values": [ + { + "value": "Sunday", + "description": "Indicates the Day referred is Sunday." + }, + { + "value": "Monday", + "description": "Indicates the Day referred is Monday." + }, + { + "value": "Tuesday", + "description": "Indicates the Day referred is Tuesday." + }, + { + "value": "Wednesday", + "description": "Indicates the Day referred is Wednesday." + }, + { + "value": "Thursday", + "description": "Indicates the Day referred is Thursday." + }, + { + "value": "Friday", + "description": "Indicates the Day referred is Friday." + }, + { + "value": "Saturday", + "description": "Indicates the Day referred is Saturday." + } + ] + } + }, + "BackupProgressInfo": { + "type": "object", + "description": "Describes the progress of a partition's backup.", + "properties": { + "BackupState": { + "$ref": "#/definitions/BackupState", + "description": "Represents the current state of the partition backup operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "TimeStamp in UTC when operation succeeded or failed." + }, + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique ID of the newly created backup." + }, + "BackupLocation": { + "type": "string", + "description": "Location, relative to the backup store, of the newly created backup." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/BackupEpoch", + "description": "Specifies the epoch of the last record included in backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "The LSN of last record included in backup." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing backup operation." + } + } + }, + "BackupConfigurationInfo": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the backup configuration information.", + "properties": { + "Kind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + }, + "PolicyName": { + "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.", + "type": "string" + }, + "PolicyInheritedFrom": { + "$ref": "#/definitions/BackupPolicyScope", + "description": "Specifies the scope at which the backup policy is applied." + }, + "SuspensionInfo": { + "$ref": "#/definitions/BackupSuspensionInfo", + "description": "Describes the backup suspension details." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionBackupConfigurationInfo": { + "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + }, + { + "type": "object", + "description": "Partition backup configuration info", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + } + ], + "x-ms-discriminator-value": "Partition" + }, + "BackupState": { + "type": "string", + "description": "Represents the current state of the partition backup operation.", + "enum": [ + "Invalid", + "Accepted", + "BackupInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "BackupState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Backup is yet to be triggered." + }, + { + "value": "BackupInProgress", + "description": "Backup operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupEntity": { + "type": "object", + "discriminator": "EntityKind", + "description": "Describes the Service Fabric entity that is configured for backup.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + } + }, + "required": [ + "EntityKind" + ] + }, + "ApplicationBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric application which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ApplicationBackupEntity", + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful service which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "ServiceBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + } + ], + "x-ms-discriminator-value": "Service" + }, + "PartitionBackupEntity": { + "type": "object", + "description": "Identifies the Service Fabric stateful partition which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + }, + { + "type": "object", + "description": "PartitionBackupEntity", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + } + ], + "x-ms-discriminator-value": "Partition" + }, + "EnableBackupDescription": { + "description": "Specifies the parameters needed to enable periodic backup.", + "required": [ + "BackupPolicyName" + ], + "properties": { + "BackupPolicyName": { + "type": "string", + "description": "Name of the backup policy to be used for enabling periodic backups." + } + } + }, + "PagedBackupEntityList": { + "type": "object", + "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup entity information.", + "items": { + "$ref": "#/definitions/BackupEntity" + } + } + } + }, + "BackupSuspensionInfo": { + "type": "object", + "description": "Describes the backup suspension details.", + "properties": { + "IsSuspended": { + "type": "boolean", + "description": "Indicates whether periodic backup is suspended at this level or not." + }, + "SuspensionInheritedFrom": { + "$ref": "#/definitions/BackupSuspensionScope", + "description": "Specifies the scope at which the backup suspension was applied." + } + } + }, + "BackupEntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupEntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application." + } + ] + } + }, + "GetBackupByStorageQueryDescription": { + "type": "object", + "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.", + "required": [ + "Storage", + "BackupEntity" + ], + "properties": { + "StartDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning." + }, + "EndDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end." + }, + "Latest": { + "type": "boolean", + "default": false, + "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore." + }, + "BackupEntity": { + "$ref": "#/definitions/BackupEntity", + "description": "Indicates the entity for which to enumerate backups." + } + } + }, + "NodeImpact": { + "type": "object", + "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "NodeName": { + "type": "string", + "description": "The name of the impacted node." + }, + "ImpactLevel": { + "type": "string", + "enum": [ + "Invalid", + "None", + "Restart", + "RemoveData", + "RemoveNode" + ], + "description": "The level of impact expected.", + "x-ms-enum": { + "name": "ImpactLevel", + "modelAsString": true, + "values": [ + { + "value": "Invalid" + }, + { + "value": "None" + }, + { + "value": "Restart" + }, + { + "value": "RemoveData" + }, + { + "value": "RemoveNode" + } + ] + } + } + }, + "required": [ + "NodeName" + ] + }, + "NodeRepairImpactDescription": { + "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairImpactDescriptionBase" + }, + { + "type": "object", + "description": "NodeRepairImpactDescription", + "properties": { + "NodeImpactList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeImpact" + }, + "description": "The list of nodes impacted by a repair action and their respective expected impact." + } + } + } + ] + }, + "NodeRepairTargetDescription": { + "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairTargetDescriptionBase" + }, + { + "type": "object", + "description": "NodeRepairTargetDescription", + "properties": { + "NodeNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of nodes targeted by a repair action." + } + } + } + ] + }, + "RepairImpactDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairImpactKind", + "description": "The kind of repair impact represented by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairImpactKind": { + "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairImpactKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair impact is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair impact affects a set of Service Fabric nodes." + } + ] + } + }, + "RepairTargetDescriptionBase": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairTargetKind", + "description": "The kind of repair target described by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairTargetKind": { + "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairTargetKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair target is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair target is a set of Service Fabric nodes." + } + ] + } + }, + "RepairTask": { + "type": "object", + "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value." + }, + "Description": { + "type": "string", + "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set." + }, + "State": { + "type": "string", + "enum": [ + "Invalid", + "Created", + "Claimed", + "Preparing", + "Approved", + "Executing", + "Restoring", + "Completed" + ], + "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.", + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Created", + "description": "Indicates that the repair task has been created." + }, + { + "value": "Claimed", + "description": "Indicates that the repair task has been claimed by a repair executor." + }, + { + "value": "Preparing", + "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully." + }, + { + "value": "Approved", + "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute." + }, + { + "value": "Executing", + "description": "Indicates that execution of the repair task is in progress." + }, + { + "value": "Restoring", + "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online." + }, + { + "value": "Completed", + "description": "Indicates that the repair task has completed, and no further state changes will occur." + } + ] + } + }, + "Flags": { + "type": "integer", + "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request" + }, + "Action": { + "type": "string", + "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set." + }, + "Target": { + "$ref": "#/definitions/RepairTargetDescriptionBase", + "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set." + }, + "Executor": { + "type": "string", + "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set." + }, + "ExecutorData": { + "type": "string", + "description": "A data string that the repair executor can use to store its internal state." + }, + "Impact": { + "$ref": "#/definitions/RepairImpactDescriptionBase", + "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set." + }, + "ResultStatus": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Cancelled", + "Interrupted", + "Failed", + "Pending" + ], + "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.", + "x-ms-enum": { + "name": "ResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Succeeded", + "description": "Indicates that the repair task completed execution successfully." + }, + { + "value": "Cancelled", + "description": "Indicates that the repair task was cancelled prior to execution." + }, + { + "value": "Interrupted", + "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed." + }, + { + "value": "Failed", + "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed." + }, + { + "value": "Pending", + "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing." + } + ] + } + }, + "ResultCode": { + "type": "integer", + "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "ResultDetails": { + "type": "string", + "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "History": { + "$ref": "#/definitions/RepairTaskHistory", + "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified." + }, + "PreparingHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Preparing state." + }, + "RestoringHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Restoring state." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state." + } + }, + "required": [ + "TaskId", + "Action", + "State" + ] + }, + "RepairTaskApproveDescription": { + "type": "object", + "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskCancelDescription": { + "type": "object", + "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + }, + "RequestAbort": { + "type": "boolean", + "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskDeleteDescription": { + "type": "object", + "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the completed repair task to be deleted." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskHealthCheckState": { + "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Skipped", + "TimedOut" + ], + "x-ms-enum": { + "name": "RepairTaskHealthCheckState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Indicates that the health check has not started." + }, + { + "value": "InProgress", + "description": "Indicates that the health check is in progress." + }, + { + "value": "Succeeded", + "description": "Indicates that the health check succeeded." + }, + { + "value": "Skipped", + "description": "Indicates that the health check was skipped." + }, + { + "value": "TimedOut", + "description": "Indicates that the health check timed out." + } + ] + } + }, + "RepairTaskHistory": { + "type": "object", + "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "CreatedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Created state." + }, + "ClaimedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Claimed state." + }, + "PreparingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Preparing state." + }, + "ApprovedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Approved state" + }, + "ExecutingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Executing state" + }, + "RestoringUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Restoring state" + }, + "CompletedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Completed state" + }, + "PreparingHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Preparing state." + }, + "PreparingHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Preparing state." + }, + "RestoringHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Restoring state." + }, + "RestoringHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Restoring state." + } + } + }, + "RepairTaskList": { + "type": "array", + "description": "A list of repair tasks.", + "items": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskUpdateHealthPolicyDescription": { + "type": "object", + "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task to be updated." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskUpdateInfo": { + "type": "object", + "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Version": { + "type": "string", + "description": "The new version of the repair task." + } + }, + "required": [ + "Version" + ] + }, + "ReconfigurationInformation": { + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.", + "properties": { + "PreviousConfigurationRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "Replica role before reconfiguration started." + }, + "ReconfigurationPhase": { + "$ref": "#/definitions/ReconfigurationPhase", + "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationType": { + "$ref": "#/definitions/ReconfigurationType", + "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time." + } + } + }, + "ReconfigurationPhase": { + "type": "string", + "description": "The reconfiguration phase of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Phase0", + "Phase1", + "Phase2", + "Phase3", + "Phase4", + "AbortPhaseZero" + ], + "x-ms-enum": { + "name": "ReconfigurationPhase", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration phase." + }, + { + "value": "None", + "description": "Specifies that there is no reconfiguration in progress." + }, + { + "value": "Phase0", + "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary." + }, + { + "value": "Phase1", + "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress." + }, + { + "value": "Phase2", + "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set." + }, + { + "value": "Phase3", + "description": "This phase is for internal use only." + }, + { + "value": "Phase4", + "description": "This phase is for internal use only." + }, + { + "value": "AbortPhaseZero", + "description": "This phase is for internal use only." + } + ] + } + }, + "ReconfigurationType": { + "type": "string", + "description": "The type of reconfiguration for replica of a stateful service.", + "enum": [ + "Unknown", + "SwapPrimary", + "Failover", + "Other" + ], + "x-ms-enum": { + "name": "ReconfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration type." + }, + { + "value": "SwapPrimary", + "description": "Specifies that the primary replica is being swapped with a different replica." + }, + { + "value": "Failover", + "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc." + }, + { + "value": "Other", + "description": "Reconfigurations where the primary replica is not changing." + } + ] + } + }, + "InfrastructureServiceResponse": { + "type": "string", + "format": "binary", + "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service." + }, + "UploadChunkRange": { + "type": "object", + "description": "Information about which portion of the file to upload.", + "properties": { + "StartPosition": { + "type": "string", + "description": "The start position of the portion of the file. It's represented by the number of bytes." + }, + "EndPosition": { + "type": "string", + "description": "The end position of the portion of the file. It's represented by the number of bytes." + } + } + }, + "UploadSessionInfo": { + "type": "object", + "description": "Information about an image store upload session. A session is associated with a relative path in the image store.", + "properties": { + "StoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "SessionId": { + "type": "string", + "format": "uuid", + "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the upload session was last modified." + }, + "FileSize": { + "type": "string", + "description": "The size in bytes of the uploading file." + }, + "ExpectedRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadChunkRange" + }, + "description": "List of chunk ranges that image store has not received yet." + } + } + }, + "UploadSession": { + "type": "object", + "description": "Information about a image store upload session", + "properties": { + "UploadSessions": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadSessionInfo" + }, + "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions." + } + } + }, + "ContainerLogs": { + "type": "object", + "description": "Container logs.", + "properties": { + "Content": { + "type": "string", + "description": "Container logs." + } + } + }, + "ScalingPolicyDescription": { + "type": "object", + "description": "Describes how the scaling should be performed", + "required": [ + "ScalingTrigger", + "ScalingMechanism" + ], + "properties": { + "ScalingTrigger": { + "$ref": "#/definitions/ScalingTriggerDescription", + "description": "Specifies the trigger associated with this scaling policy" + }, + "ScalingMechanism": { + "$ref": "#/definitions/ScalingMechanismDescription", + "description": "Specifies the mechanism associated with this scaling policy" + } + } + }, + "ScalingPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicyDescription" + }, + "description": "A list that describes the scaling policies." + }, + "ScalingTriggerDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingTriggerKind", + "description": "Specifies the kind of scaling trigger" + } + } + }, + "ScalingMechanismDescription": { + "type": "object", + "discriminator": "Kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingMechanismKind", + "description": "Specifies the kind of scaling mechanism" + } + } + }, + "ScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "AveragePartitionLoad", + "AverageServiceLoad" + ], + "x-ms-enum": { + "name": "ScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "AveragePartitionLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1." + }, + { + "value": "AverageServiceLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2." + } + ] + } + }, + "ScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "PartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PartitionInstanceCount", + "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2." + } + ] + } + }, + "AveragePartitionLoadScalingTrigger": { + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AverageServiceLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "PartitionInstanceCount", + "required": [ + "MinInstanceCount", + "MaxInstanceCount", + "ScaleIncrement" + ], + "properties": { + "MinInstanceCount": { + "type": "integer", + "description": "Minimum number of instances of the partition." + }, + "MaxInstanceCount": { + "type": "integer", + "description": "Maximum number of instances of the partition." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "MinPartitionCount", + "MaxPartitionCount", + "ScaleIncrement" + ], + "properties": { + "MinPartitionCount": { + "type": "integer", + "description": "Minimum number of named partitions of the service." + }, + "MaxPartitionCount": { + "type": "integer", + "description": "Maximum number of named partitions of the service." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationCreatedEvent": { + "description": "Application Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "Application definition kind." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "ApplicationDefinitionKind" + ] + } + ], + "x-ms-discriminator-value": "ApplicationCreated" + }, + "ApplicationDeletedEvent": { + "description": "Application Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + } + ], + "x-ms-discriminator-value": "ApplicationDeleted" + }, + "ApplicationHealthReportCreatedEvent": { + "description": "Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ApplicationHealthReportCreated" + }, + "ApplicationHealthReportExpiredEvent": { + "description": "Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ApplicationHealthReportExpired" + }, + "ApplicationUpgradeCompleteEvent": { + "description": "Application Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeComplete" + }, + "ApplicationUpgradeDomainCompleteEvent": { + "description": "Application Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Upgrade time of domain in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeDomainComplete" + }, + "ApplicationUpgradeRollbackCompleteEvent": { + "description": "Application Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackComplete" + }, + "ApplicationUpgradeRollbackStartEvent": { + "description": "Application Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackStart" + }, + "ApplicationUpgradeStartEvent": { + "description": "Application Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ] + } + ], + "x-ms-discriminator-value": "ApplicationUpgradeStart" + }, + "DeployedApplicationHealthReportCreatedEvent": { + "description": "Deployed Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedApplicationHealthReportCreated" + }, + "DeployedApplicationHealthReportExpiredEvent": { + "description": "Deployed Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired" + }, + "ProcessDeactivatedEvent": { + "description": "Process Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ExeName": { + "type": "string", + "description": "Name of executable." + }, + "ProcessId": { + "type": "integer", + "format": "int64", + "description": "Process Id." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ExeName", + "ProcessId", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "ProcessDeactivated" + }, + "ContainerDeactivatedEvent": { + "description": "Container Deactivated event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ImageName": { + "type": "string", + "description": "Name of Container image." + }, + "ContainerName": { + "type": "string", + "description": "Name of Container." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ImageName", + "ContainerName", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "ContainerDeactivated" + }, + "NodeAbortedEvent": { + "description": "Node Aborted event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeAborted" + }, + "NodeAbortingEvent": { + "description": "Node Aborting event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeAborting" + }, + "NodeAddedEvent": { + "description": "Node Added event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ] + } + ], + "x-ms-discriminator-value": "NodeAdded" + }, + "NodeCloseEvent": { + "description": "Node Close event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "string", + "description": "Id of Node instance." + }, + "Error": { + "type": "string", + "description": "Describes error." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "Error" + ] + } + ], + "x-ms-discriminator-value": "NodeClose" + }, + "NodeClosingEvent": { + "description": "Node Closing event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeClosing" + }, + "NodeDeactivateCompleteEvent": { + "description": "Node Deactivate Complete event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "EffectiveDeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + }, + "BatchIdsWithDeactivateIntent": { + "type": "string", + "description": "Batch Ids." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time." + } + }, + "required": [ + "NodeInstance", + "EffectiveDeactivateIntent", + "BatchIdsWithDeactivateIntent", + "StartTime" + ] + } + ], + "x-ms-discriminator-value": "NodeDeactivateComplete" + }, + "NodeDeactivateStartEvent": { + "description": "Node Deactivate Start event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "BatchId": { + "type": "string", + "description": "Batch Id." + }, + "DeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + } + }, + "required": [ + "NodeInstance", + "BatchId", + "DeactivateIntent" + ] + } + ], + "x-ms-discriminator-value": "NodeDeactivateStart" + }, + "NodeDownEvent": { + "description": "Node Down event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last up." + } + }, + "required": [ + "NodeInstance", + "LastNodeUpAt" + ] + } + ], + "x-ms-discriminator-value": "NodeDown" + }, + "NodeHealthReportCreatedEvent": { + "description": "Node Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "NodeHealthReportCreated" + }, + "NodeHealthReportExpiredEvent": { + "description": "Node Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "NodeHealthReportExpired" + }, + "NodeOpenedSuccessEvent": { + "description": "Node Opened Success event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeOpenedSuccess" + }, + "NodeOpenFailedEvent": { + "description": "Node Open Failed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + }, + "Error": { + "type": "string", + "description": "Describes the error." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion", + "Error" + ] + } + ], + "x-ms-discriminator-value": "NodeOpenFailed" + }, + "NodeOpeningEvent": { + "description": "Node Opening event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ] + } + ], + "x-ms-discriminator-value": "NodeOpening" + }, + "NodeRemovedEvent": { + "description": "Node Removed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ] + } + ], + "x-ms-discriminator-value": "NodeRemoved" + }, + "NodeUpEvent": { + "description": "Node Up event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last down." + } + }, + "required": [ + "NodeInstance", + "LastNodeDownAt" + ] + } + ], + "x-ms-discriminator-value": "NodeUp" + }, + "PartitionHealthReportCreatedEvent": { + "description": "Partition Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "PartitionHealthReportCreated" + }, + "PartitionHealthReportExpiredEvent": { + "description": "Partition Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "PartitionHealthReportExpired" + }, + "PartitionReconfigurationCompletedEvent": { + "description": "Partition Reconfiguration Completed event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "Id of Node instance." + }, + "ServiceType": { + "type": "string", + "description": "Type of Service." + }, + "CcEpochDataLossVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochDataLoss version." + }, + "CcEpochConfigVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochConfig version." + }, + "ReconfigType": { + "type": "string", + "description": "Type of reconfiguration." + }, + "Result": { + "type": "string", + "description": "Describes reconfiguration result." + }, + "Phase0DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase0 in milli-seconds." + }, + "Phase1DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase1 in milli-seconds." + }, + "Phase2DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase2 in milli-seconds." + }, + "Phase3DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase3 in milli-seconds." + }, + "Phase4DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase4 in milli-seconds." + }, + "TotalDurationMs": { + "type": "number", + "format": "double", + "description": "Total duration in milli-seconds." + } + }, + "required": [ + "NodeName", + "NodeInstanceId", + "ServiceType", + "CcEpochDataLossVersion", + "CcEpochConfigVersion", + "ReconfigType", + "Result", + "Phase0DurationMs", + "Phase1DurationMs", + "Phase2DurationMs", + "Phase3DurationMs", + "Phase4DurationMs", + "TotalDurationMs" + ] + } + ], + "x-ms-discriminator-value": "PartitionReconfigurationCompleted" + }, + "PartitionPrimaryMoveAnalysisEvent": { + "description": "Partition Primary Move Analysis event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionAnalysisEvent" + }, + { + "type": "object", + "properties": { + "WhenMoveCompleted": { + "type": "string", + "format": "date-time", + "description": "Time when the move was completed." + }, + "PreviousNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "CurrentNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "MoveReason": { + "type": "string", + "description": "Move reason." + }, + "RelevantTraces": { + "type": "string", + "description": "Relevant traces." + } + }, + "required": [ + "WhenMoveCompleted", + "PreviousNode", + "CurrentNode", + "MoveReason", + "RelevantTraces" + ] + } + ], + "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis" + }, + "ServiceCreatedEvent": { + "description": "Service Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion", + "PartitionId" + ] + } + ], + "x-ms-discriminator-value": "ServiceCreated" + }, + "ServiceDeletedEvent": { + "description": "Service Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion" + ] + } + ], + "x-ms-discriminator-value": "ServiceDeleted" + }, + "ServiceHealthReportCreatedEvent": { + "description": "Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ServiceHealthReportCreated" + }, + "ServiceHealthReportExpiredEvent": { + "description": "Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + }, + { + "type": "object", + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ServiceHealthReportExpired" + }, + "DeployedServiceHealthReportCreatedEvent": { + "description": "Deployed Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TTLTimespan": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifestName", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportCreated" + }, + "DeployedServiceHealthReportExpiredEvent": { + "description": "Deployed Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "ServiceManifest": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TTLTimespan": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifest", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TTLTimespan", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "DeployedServiceHealthReportExpired" + }, + "StatefulReplicaHealthReportCreatedEvent": { + "description": "Stateful Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatefulReplicaHealthReportCreated" + }, + "StatefulReplicaHealthReportExpiredEvent": { + "description": "Stateful Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired" + }, + "StatelessReplicaHealthReportCreatedEvent": { + "description": "Stateless Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatelessReplicaHealthReportCreated" + }, + "StatelessReplicaHealthReportExpiredEvent": { + "description": "Stateless Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired" + }, + "ClusterHealthReportCreatedEvent": { + "description": "Cluster Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ClusterHealthReportCreated" + }, + "ClusterHealthReportExpiredEvent": { + "description": "Cluster Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ] + } + ], + "x-ms-discriminator-value": "ClusterHealthReportExpired" + }, + "ClusterUpgradeCompleteEvent": { + "description": "Cluster Upgrade Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeComplete" + }, + "ClusterUpgradeDomainCompleteEvent": { + "description": "Cluster Upgrade Domain Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Duration of domain upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeDomainComplete" + }, + "ClusterUpgradeRollbackCompleteEvent": { + "description": "Cluster Upgrade Rollback Complete event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackComplete" + }, + "ClusterUpgradeRollbackStartEvent": { + "description": "Cluster Upgrade Rollback Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackStart" + }, + "ClusterUpgradeStartEvent": { + "description": "Cluster Upgrade Start event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "CurrentClusterVersion": { + "type": "string", + "description": "Current Cluster version." + }, + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "CurrentClusterVersion", + "TargetClusterVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ] + } + ], + "x-ms-discriminator-value": "ClusterUpgradeStart" + }, + "ChaosStoppedEvent": { + "description": "Chaos Stopped event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "Reason": { + "type": "string", + "description": "Describes reason." + } + }, + "required": [ + "Reason" + ] + } + ], + "x-ms-discriminator-value": "ChaosStopped" + }, + "ChaosStartedEvent": { + "description": "Chaos Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + }, + { + "type": "object", + "properties": { + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "Maximum number of concurrent faults." + }, + "TimeToRunInSeconds": { + "type": "number", + "format": "double", + "description": "Time to run in seconds." + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "number", + "format": "double", + "description": "Maximum timeout for cluster stabilization in seconds." + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between iterations in seconds." + }, + "WaitTimeBetweenFautlsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between faults in seconds." + }, + "MoveReplicaFaultEnabled": { + "type": "boolean", + "description": "Indicates MoveReplica fault is enabled." + }, + "IncludedNodeTypeList": { + "type": "string", + "description": "List of included Node types." + }, + "IncludedApplicationList": { + "type": "string", + "description": "List of included Applications." + }, + "ClusterHealthPolicy": { + "type": "string", + "description": "Health policy." + }, + "ChaosContext": { + "type": "string", + "description": "Chaos Context." + } + }, + "required": [ + "MaxConcurrentFaults", + "TimeToRunInSeconds", + "MaxClusterStabilizationTimeoutInSeconds", + "WaitTimeBetweenIterationsInSeconds", + "WaitTimeBetweenFautlsInSeconds", + "MoveReplicaFaultEnabled", + "IncludedNodeTypeList", + "IncludedApplicationList", + "ClusterHealthPolicy", + "ChaosContext" + ] + } + ], + "x-ms-discriminator-value": "ChaosStarted" + }, + "ChaosRestartNodeFaultCompletedEvent": { + "description": "Chaos Restart Node Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + } + }, + "required": [ + "NodeInstanceId", + "FaultGroupId", + "FaultId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartNodeFaultCompleted" + }, + "ChaosRestartCodePackageFaultScheduledEvent": { + "description": "Chaos Restart Code Package Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "CodePackageName": { + "type": "string", + "description": "Code package name." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "NodeName", + "ServiceManifestName", + "CodePackageName", + "ServicePackageActivationId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartCodePackageFaultScheduled" + }, + "ChaosRestartCodePackageFaultCompletedEvent": { + "description": "Chaos Restart Code Package Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "CodePackageName": { + "type": "string", + "description": "Code package name." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "NodeName", + "ServiceManifestName", + "CodePackageName", + "ServicePackageActivationId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartCodePackageFaultCompleted" + }, + "ChaosRemoveReplicaFaultScheduledEvent": { + "description": "Chaos Remove Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRemoveReplicaFaultScheduled" + }, + "ChaosRemoveReplicaFaultCompletedEvent": { + "description": "Chaos Remove Replica Fault Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRemoveReplicaFaultCompleted" + }, + "ChaosMoveSecondaryFaultScheduledEvent": { + "description": "Chaos Move Secondary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "SourceNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "DestinationNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "SourceNode", + "DestinationNode", + "ForcedMove" + ] + } + ], + "x-ms-discriminator-value": "ChaosMoveSecondaryFaultScheduled" + }, + "ChaosMovePrimaryFaultScheduledEvent": { + "description": "Chaos Move Primary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "NodeTo": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "NodeTo", + "ForcedMove" + ] + } + ], + "x-ms-discriminator-value": "ChaosMovePrimaryFaultScheduled" + }, + "ChaosRestartReplicaFaultScheduledEvent": { + "description": "Chaos Restart Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + }, + { + "type": "object", + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartReplicaFaultScheduled" + }, + "ChaosRestartNodeFaultScheduledEvent": { + "description": "Chaos Restart Node Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + }, + { + "type": "object", + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + } + }, + "required": [ + "NodeInstanceId", + "FaultGroupId", + "FaultId" + ] + } + ], + "x-ms-discriminator-value": "ChaosRestartNodeFaultScheduled" + }, + "ApplicationResourceDescription": { + "type": "object", + "description": "Describes a service fabric application resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "This type describes properties of an application resource." + }, + "name": { + "$ref": "#/definitions/ApplicationResourceName", + "description": "Application resource name." + } + }, + "required": [ + "name", + "properties" + ] + }, + "ApplicationResourceName": { + "type": "string", + "description": "Application resource name." + }, + "PagedServiceResourceDescriptionList": { + "type": "object", + "description": "The list of service resources in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service resource description.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + }, + "x-sf-clientlib": { + "TypeName": "PagedData", + "SkipGeneration": "true" + } + }, + "PagedServiceResourceReplicaDescriptionList": { + "type": "object", + "description": "The list of service resources in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service resource description.", + "items": { + "$ref": "#/definitions/ServiceResourceReplicaDescription" + } + } + }, + "x-sf-clientlib": { + "TypeName": "PagedData", + "SkipGeneration": "true" + } + }, + "ServiceResourceDescription": { + "type": "object", + "description": "Describes a service fabric service resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + }, + "name": { + "$ref": "#/definitions/ServiceResourceName", + "description": "Service resource name." + } + }, + "required": [ + "name", + "properties" + ] + }, + "ServiceResourceName": { + "type": "string", + "description": "Service resource name." + }, + "ServiceResourceReplicaDescription": { + "type": "object", + "description": "Describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + }, + "required": [ + "replicaName" + ] + } + ] + }, + "VolumeResourceName": { + "type": "string", + "description": "Volume resource name." + }, + "VolumeResourceDescription": { + "type": "object", + "description": "Describes a service fabric volume resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeProperties", + "description": "This type describes properties of a volume resource." + }, + "name": { + "$ref": "#/definitions/VolumeResourceName", + "description": "Volume resource name." + } + }, + "required": [ + "name", + "properties" + ] + }, + "ApplicationProperties": { + "description": "This type describes properties of an application resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the application.", + "type": "string" + }, + "debugParams": { + "description": "Internal use.", + "type": "string" + }, + "services": { + "type": "array", + "description": "describes the services in the application.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the application resource.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationResourceStatus", + "modelAsString": true + } + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application deployment." + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + } + } + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the code package.", + "type": "string" + }, + "image": { + "description": "The Container image to use.", + "type": "string" + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Image registry credential." + }, + "entrypoint": { + "description": "Override for the default entry point in the container.", + "type": "string" + }, + "commands": { + "description": "Command array to execute within the container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in this container", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "settings": { + "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "labels": { + "description": "The labels to set in this container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + "endpoints": { + "description": "The endpoints exposed by this container.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "resources": { + "$ref": "#/definitions/ResourceRequirements", + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "description": "The volumes to be attached to the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerVolume" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerEvent": { + "description": "A container event.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the container event." + }, + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "description": "Date/time of the first event." + }, + "lastTimestamp": { + "type": "string", + "description": "Date/time of the last event." + }, + "message": { + "type": "string", + "description": "The event message" + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "type": "object", + "properties": { + "restartCount": { + "type": "integer", + "description": "The number of times the container has been restarted." + }, + "currentState": { + "$ref": "#/definitions/ContainerState", + "description": "Current container instance state." + }, + "previousState": { + "$ref": "#/definitions/ContainerState", + "description": "Previous container instance state." + }, + "events": { + "description": "The events of this container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerEvent" + } + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "type": "object", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerState": { + "description": "The container state.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of this container" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state started." + }, + "exitCode": { + "type": "string", + "description": "The container exit code." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state finished." + }, + "detailStatus": { + "description": "Human-readable status of this state.", + "type": "string" + } + } + }, + "ContainerVolume": { + "description": "Describes how a volume is attached to a container.", + "type": "object", + "properties": { + "name": { + "description": "Name of the volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume is read only. Default is 'false'.", + "type": "boolean" + }, + "destinationPath": { + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", + "type": "string" + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "type": "object", + "properties": { + "sinks": { + "description": "List of supported sinks that can be referenced.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "defaultSinkRefs": { + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsRef": { + "description": "Reference to sinks in DiagnosticsDescription.", + "type": "object", + "properties": { + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "sinkRefs": { + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsSinkKind": { + "type": "string", + "description": "The kind of DiagnosticsSink.", + "enum": [ + "Invalid", + "AzureInternalMonitoringPipeline" + ], + "x-ms-enum": { + "name": "DiagnosticsSinkKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva." + } + ] + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/DiagnosticsSinkKind", + "description": "The kind of DiagnosticsSink." + }, + "name": { + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", + "type": "string" + }, + "description": { + "description": "A description of the sink.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network." + } + } + }, + "ResourceLimits": { + "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "CPU limits in cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + } + }, + "ResourceRequests": { + "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory request in GB for this container.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "Requested number of CPU cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + }, + "required": [ + "memoryInGB", + "cpu" + ] + }, + "ResourceRequirements": { + "description": "This type describes the resource requirements for a container or a service.", + "type": "object", + "properties": { + "requests": { + "$ref": "#/definitions/ResourceRequests", + "description": "Describes the requested resources for a given container." + }, + "limits": { + "$ref": "#/definitions/ResourceLimits", + "description": "Describes the maximum limits on the resources for a given container." + } + }, + "required": [ + "requests" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "description": { + "description": "User readable description of the service.", + "type": "string" + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "healthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Represents the status of the service.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceResourceStatus", + "modelAsString": true + } + } + } + } + ] + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "type": "object", + "properties": { + "osType": { + "type": "string", + "description": "The Operating system type required by the code in service.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "codePackages": { + "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + "networkRefs": { + "type": "array", + "description": "The names of the private networks that this service needs to be part of.", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "osType", + "codePackages" + ] + }, + "Setting": { + "description": "Describes a setting for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "VolumeProperties": { + "description": "This type describes properties of a volume resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the volume.", + "type": "string" + }, + "provider": { + "description": "Provider of the volume.", + "type": "string", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true + } + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "type": "object", + "properties": { + "accountName": { + "description": "Name of the Azure storage account for the File Share.", + "type": "string" + }, + "accountKey": { + "description": "Access key of the Azure storage account for the File Share.", + "type": "string" + }, + "shareName": { + "description": "Name of the Azure Files file share that provides storage for the volume.", + "type": "string" + } + }, + "required": [ + "accountName", + "shareName" + ] + } + }, + "parameters": { + "ApiVersion_6-0-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0-preview" + ], + "required": true, + "default": "6.0-preview", + "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-0-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0-preview", + "description": "The version number for the preview functionality of 6.0 runtime." + } + ] + } + }, + "ApiVersion_6-0_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0" + ], + "required": true, + "default": "6.0", + "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-0_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0", + "description": "The 6.0 version of the API." + } + ] + } + }, + "ApiVersion_6-1_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.1" + ], + "required": true, + "default": "6.1", + "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-1_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.1", + "description": "The 6.1 version of the API." + } + ] + } + }, + "ApiVersion_6-2_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2" + ], + "required": true, + "default": "6.2", + "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-2_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2", + "description": "The 6.2 version of the API." + } + ] + } + }, + "ApiVersion_6-2-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2-preview" + ], + "required": true, + "default": "6.2-preview", + "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-2-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2-preview", + "description": "The version number for the preview functionality of 6.2 runtime" + } + ] + } + }, + "ApiVersion_6-3_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.3" + ], + "required": true, + "default": "6.3", + "description": "The version of the API. This parameter is required and its value must be '6.3'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-3_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.3", + "description": "The 6.3 version of the API." + } + ] + } + }, + "ApiVersion_6-3-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.3-preview" + ], + "required": true, + "default": "6.3-preview", + "description": "The version of the API. This parameter is required and its value must be '6.3-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-3-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.3-preview", + "description": "The version number for the preview functionality of 6.3 runtime" + } + ] + } + }, + "ApplicationDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationDefinitionKindFilter", + "description": "Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationHealthPolicyOptionalBodyParam": { + "name": "ApplicationHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + }, + "ApplicationIdRequiredPathParam": { + "name": "applicationId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationsHealthStateFilterOptionalQueryParam": { + "name": "ApplicationsHealthStateFilter", + "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationTypeDefinitionKindFilter", + "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeNameOptionalQueryParam": { + "name": "ApplicationTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The application type name used to filter the applications to query for. This value should not contain the application type version." + }, + "ApplicationTypeNameRequiredPathParam": { + "name": "applicationTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the application type." + }, + "ApplicationTypeVersionOptionalQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The version of the application type." + }, + "ApplicationTypeVersionRequiredQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The version of the application type." + }, + "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": { + "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam", + "in": "body", + "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + } + }, + "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": { + "name": "ClusterConfigurationUpgradeDescription", + "in": "body", + "description": "Parameters for a standalone cluster configuration upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeDescription" + } + }, + "ClusterHealthPoliciesOptionalBodyParam": { + "name": "ClusterHealthPolicies", + "in": "body", + "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicies" + } + }, + "ClusterHealthPolicyOptionalBodyParam": { + "name": "ClusterHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicy" + } + }, + "ClusterHealthChunkQueryDescriptionOptionalBodyParam": { + "name": "ClusterHealthChunkQueryDescription", + "in": "body", + "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthChunkQueryDescription" + } + }, + "CodePackageInstanceIdRequiredQueryParam": { + "name": "CodePackageInstanceId", + "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "CodeVersionOptionalQueryParam": { + "name": "CodeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The product version of Service Fabric." + }, + "ConfigVersionOptionalQueryParam": { + "name": "ConfigVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The config version of Service Fabric." + }, + "ConfigurationApiVersionRequiredQueryParam": { + "name": "ConfigurationApiVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The API version of the Standalone cluster json configuration." + }, + "ContainerApiRequiredBodyParam": { + "name": "ContainerApiRequestBody", + "in": "body", + "description": "Parameters for making container API call", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ContainerApiRequestBody" + } + }, + "ContinuationTokenOptionalQueryParam": { + "name": "ContinuationToken", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." + }, + "DeployedApplicationsHealthStateFilterOptionalQueryParam": { + "name": "DeployedApplicationsHealthStateFilter", + "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServicePackagesHealthStateFilterOptionalQueryParam": { + "name": "DeployedServicePackagesHealthStateFilter", + "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeploymentNameRequiredPathParam": { + "name": "deploymentName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the deployment." + }, + "EventsHealthStateFilterOptionalQueryParam": { + "name": "EventsHealthStateFilter", + "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ExcludeApplicationParametersOptionalQueryParam": { + "name": "ExcludeApplicationParameters", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "The flag that specifies whether application parameters will be excluded from the result." + }, + "HealthInformationRequiredBodyParam": { + "name": "HealthInformation", + "in": "body", + "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/HealthInformation" + } + }, + "NodeNameRequiredPathParam": { + "name": "nodeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the node." + }, + "NodesHealthStateFilterOptionalQueryParam": { + "name": "NodesHealthStateFilter", + "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "NodeStatusFilterOptionalQueryParam": { + "name": "NodeStatusFilter", + "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default", + "all", + "up", + "down", + "enabling", + "disabling", + "disabled", + "unknown", + "removed" + ], + "required": false, + "default": "default", + "x-ms-enum": { + "name": "NodeStatusFilter", + "modelAsString": true, + "values": [ + { + "value": "default", + "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." + }, + { + "value": "all", + "description": "This filter value will match all of the nodes." + }, + { + "value": "up", + "description": "This filter value will match nodes that are Up." + }, + { + "value": "down", + "description": "This filter value will match nodes that are Down." + }, + { + "value": "enabling", + "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling." + }, + { + "value": "disabling", + "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling." + }, + { + "value": "disabled", + "description": "This filter value will match nodes that are Disabled." + }, + { + "value": "unknown", + "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime." + }, + { + "value": "removed", + "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API." + } + ] + } + }, + "PartitionIdOptionalQueryParam": { + "name": "PartitionId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": false, + "description": "The identity of the partition." + }, + "PartitionIdRequiredPathParam": { + "name": "partitionId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "format": "uuid", + "required": true, + "description": "The identity of the partition." + }, + "ProvisionFabricDescriptionRequiredBodyParam": { + "name": "ProvisionFabricDescription", + "in": "body", + "description": "Describes the parameters for provisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionFabricDescription" + } + }, + "UnprovisionFabricDescriptionRequiredBodyParam": { + "name": "UnprovisionFabricDescription", + "in": "body", + "description": "Describes the parameters for unprovisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionFabricDescription" + } + }, + "ResumeClusterUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeClusterUpgradeDescription" + } + }, + "UpdateClusterUpgradeDescriptionRequiredBodyParam": { + "name": "UpdateClusterUpgradeDescription", + "in": "body", + "description": "Parameters for updating a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UpdateClusterUpgradeDescription" + } + }, + "StartClusterUpgradeDescriptionRequiredBodyParam": { + "name": "StartClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for starting a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/StartClusterUpgradeDescription" + } + }, + "ReplicaHealthReportServiceKindRequiredQueryParam": { + "name": "ReplicaHealthReportServiceKind", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.", + "type": "string", + "enum": [ + "Stateless", + "Stateful" + ], + "default": "Stateful", + "x-ms-enum": { + "name": "ReplicaHealthReportServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1" + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ReplicaIdRequiredPathParam": { + "name": "replicaId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identifier of the replica." + }, + "ReplicasHealthStateFilerOptionalQueryParam": { + "name": "ReplicasHealthStateFilter", + "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ServiceIdRequiredPathParam": { + "name": "serviceId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServiceManifestNameRequiredQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServicePackageNameRequiredPathParam": { + "name": "servicePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the service package." + }, + "ServicesHealthStateFilterOptionalQueryParam": { + "name": "ServicesHealthStateFilter", + "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values,\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "CreateServiceFromTemplateRequiredBodyParam": { + "name": "ServiceFromTemplateDescription", + "in": "body", + "description": "Describes the service that needs to be created from the template defined in the application manifest.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceFromTemplateDescription" + } + }, + "ServiceTypeNameOptionalQueryParam": { + "name": "ServiceTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The service type name used to filter the services to query for." + }, + "InfrastructureCommandRequiredQueryParam": { + "name": "Command", + "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "InfrastructureServiceIdOptionalQueryParam": { + "name": "ServiceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.", + "required": false + }, + "ForceRemoveOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "ForceRemoveReplicaOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "DeactivationIntentDescriptionRequiredBodyParam": { + "name": "DeactivationIntentDescription", + "in": "body", + "description": "Describes the intent or reason for deactivating the node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeactivationIntentDescription" + } + }, + "RestartNodeDescriptionRequiredBodyParam": { + "name": "RestartNodeDescription", + "in": "body", + "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartNodeDescription" + } + }, + "ApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeDescription", + "in": "body", + "description": "Parameters for an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeDescription" + } + }, + "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": { + "name": "ComposeDeploymentUpgradeDescription", + "in": "body", + "description": "Parameters for upgrading compose deployment.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeDescription" + } + }, + "ApplicationTypeImageStorePathRequiredBodyParam": { + "name": "ApplicationTypeImageStorePath", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationTypeImageStorePath" + } + }, + "UnprovisionApplicationTypeRequiredBodyParam": { + "name": "UnprovisionApplicationTypeDescriptionInfo", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo" + } + }, + "UpgradeOrchestrationServiceStateRequiredBodyParam": { + "name": "UpgradeOrchestrationServiceState", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "ChaosParametersRequiredBodyParam": { + "name": "ChaosParameters", + "in": "body", + "description": "Describes all the parameters to configure a Chaos run.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosParameters" + } + }, + "StartTimeUtcOptionalQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "EndTimeUtcOptionalQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "ApplicationNameRequiredQueryParam": { + "name": "ApplicationName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme." + }, + "CreateComposeDeploymentRequiredBodyParam": { + "name": "CreateComposeDeploymentDescription", + "in": "body", + "description": "Describes the compose deployment that needs to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/CreateComposeDeploymentDescription" + } + }, + "PasswordEncryptedOptionalQueryParam": { + "name": "PasswordEncrypted", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Indicates that supplied container repository password is encrypted." + }, + "RepositoryPasswordOptionalQueryParam": { + "name": "RepositoryPassword", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The password for supplied username to connect to container repository." + }, + "RepositoryUserNameOptionalQueryParam": { + "name": "RepositoryUserName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The user name to connect to container repository." + }, + "MaxResultsOptionalQueryParam": { + "name": "MaxResults", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "minimum": 0, + "default": 0, + "required": false, + "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." + }, + "ApplicationDescriptionRequiredBodyParam": { + "name": "ApplicationDescription", + "in": "body", + "description": "Description for creating an application.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationDescription" + } + }, + "ServiceDescriptionRequiredBodyParam": { + "name": "ServiceDescription", + "in": "body", + "description": "The information necessary to create a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "ServiceUpdateDescriptionRequiredBodyParam": { + "name": "ServiceUpdateDescription", + "in": "body", + "description": "The information necessary to update a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceUpdateDescription" + } + }, + "ImageStoreCopyDescriptionRequiredBodyParam": { + "name": "ImageStoreCopyDescription", + "in": "body", + "description": "Describes the copy description for the image store.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ImageStoreCopyDescription" + } + }, + "CodePackageNameOptionalQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "CodePackageNameRequiredQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "RestartDeployedCodePackageRequiredBodyParam": { + "name": "RestartDeployedCodePackageDescription", + "in": "body", + "description": "Describes the deployed code package on Service Fabric node to restart.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartDeployedCodePackageDescription" + } + }, + "PartitionsHealthStateFilterOptionalQueryParam": { + "name": "PartitionsHealthStateFilter", + "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServiceType_ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." + }, + "ServiceTypeNameRequiredPathParam": { + "name": "serviceTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Specifies the name of a Service Fabric service type." + }, + "ImageStoreContentPathRequiredPathParam": { + "name": "contentPath", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "Relative path to file or folder in the image store from its root." + }, + "PartitionKeyTypeOptionalQueryParam": { + "name": "PartitionKeyType", + "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "PartitionKeyValueOptionalQueryParam": { + "name": "PartitionKeyValue", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named." + }, + "PreviousRspVersionOptionalQueryParam": { + "name": "PreviousRspVersion", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale." + }, + "DataLossModeRequiredQueryParam": { + "name": "DataLossMode", + "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "PartialDataLoss", + "FullDataLoss" + ], + "required": true, + "x-ms-enum": { + "name": "DataLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "PartialDataLoss", + "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition." + }, + { + "value": "FullDataLoss", + "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost." + } + ] + } + }, + "FaultOperationIdRequiredQueryParam": { + "name": "OperationId", + "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true + }, + "ForceRequiredQueryParam": { + "name": "Force", + "description": "Indicates whether to gracefully rollback and clean up internal system state modified by executing the user-induced operation.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": true, + "default": false + }, + "NodeInstanceIdRequiredQueryParam": { + "name": "NodeInstanceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API." + }, + "NodeTransitionTypeRequiredQueryParam": { + "name": "NodeTransitionType", + "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "Start", + "Stop" + ], + "required": true, + "x-ms-enum": { + "name": "NodeTransitionType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "Start", + "description": "Transition a stopped node to up." + }, + { + "value": "Stop", + "description": "Transition an up node to stopped." + } + ] + } + }, + "QuorumLossDurationRequiredQueryParam": { + "name": "QuorumLossDuration", + "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true + }, + "QuorumLossModeRequiredQueryParam": { + "name": "QuorumLossMode", + "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "QuorumReplicas", + "AllReplicas" + ], + "required": true, + "x-ms-enum": { + "name": "QuorumLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "QuorumReplicas", + "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss." + }, + { + "value": "AllReplicas" + } + ] + } + }, + "RestartPartitionModeRequiredQueryParam": { + "name": "RestartPartitionMode", + "description": "Describe which partitions to restart.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "AllReplicasOrInstances", + "OnlyActiveSecondaries" + ], + "required": true, + "x-ms-enum": { + "name": "RestartPartitionMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "AllReplicasOrInstances", + "description": "All replicas or instances in the partition are restarted at once." + }, + { + "value": "OnlyActiveSecondaries", + "description": "Only the secondary replicas are restarted." + } + ] + } + }, + "StateFilterRequiredQueryParam": { + "name": "StateFilter", + "description": "Used to filter on OperationState's for user-induced operations.\n\n- 65535 - select All\n- 1 - select Running\n- 2 - select RollingBack\n- 8 - select Completed\n- 16 - select Faulted\n- 32 - select Cancelled\n- 64 - select ForceCancelled", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "StopDurationInSecondsRequiredQueryParam": { + "name": "StopDurationInSeconds", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int32", + "minimum": 0, + "required": true, + "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up." + }, + "TypeFilterRequiredQueryParam": { + "name": "TypeFilter", + "description": "Used to filter on OperationType for user-induced operations.\n\n- 65535 - select all\n- 1 - select PartitionDataLoss.\n- 2 - select PartitionQuorumLoss.\n- 4 - select PartitionRestart.\n- 8 - select NodeTransition.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "DeployServicePackageToNodeRequiredBodyParam": { + "name": "DeployServicePackageToNodeDescription", + "in": "body", + "description": "Describes information for deploying a service package to a Service Fabric node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeployServicePackageToNodeDescription" + } + }, + "ResumeApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeApplicationUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeApplicationUpgradeDescription" + } + }, + "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeUpdateDescription", + "in": "body", + "description": "Parameters for updating an existing application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeUpdateDescription" + } + }, + "TimeoutOptionalQueryParam": { + "name": "timeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "required": false, + "minimum": 1, + "maximum": 4294967295, + "default": 60, + "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." + }, + "NameDescriptionRequiredBodyParam": { + "name": "NameDescription", + "in": "body", + "description": "Describes the Service Fabric name to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NameDescription" + } + }, + "NameIdRequiredPathParam": { + "name": "nameId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The Service Fabric name, without the 'fabric:' URI scheme." + }, + "RecursiveOptionalQueryParam": { + "name": "Recursive", + "description": "Allows specifying that the search performed should be recursive.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeValuesOptionalQueryParam": { + "name": "IncludeValues", + "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "PropertyDescriptionRequiredBodyParam": { + "name": "PropertyDescription", + "in": "body", + "description": "Describes the Service Fabric property to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyDescription" + } + }, + "PropertyNameRequiredQueryParam": { + "name": "PropertyName", + "description": "Specifies the name of the property to get.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "PropertyBatchDescriptionListRequiredBodyParam": { + "name": "PropertyBatchDescriptionList", + "in": "body", + "description": "Describes the property batch operations to be submitted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyBatchDescriptionList" + } + }, + "ImmediateOptionalQueryParam": { + "name": "Immediate", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." + }, + "ExcludeHealthStatisticsOptionalQueryParam": { + "name": "ExcludeHealthStatistics", + "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": { + "name": "IncludeSystemApplicationHealthStatistics", + "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeHealthStateOptionalQueryParam": { + "name": "IncludeHealthState", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time." + }, + "BackupPolicyDescriptionRequiredBodyParam": { + "name": "BackupPolicyDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the backup policy.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "BackupPolicyNameRequiredPathParam": { + "name": "backupPolicyName", + "in": "path", + "description": "The name of the backup policy.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "EnableBackupDescriptionRequiredBodyParam": { + "name": "EnableBackupDescription", + "in": "body", + "description": "Specifies the parameters for enabling backup.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/EnableBackupDescription" + } + }, + "RestorePartitionDescriptionRequiredBodyParam": { + "name": "RestorePartitionDescription", + "in": "body", + "description": "Describes the parameters to restore the partition.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestorePartitionDescription" + } + }, + "RestoreTimeoutOptionalQueryParam": { + "name": "RestoreTimeout", + "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 10 + }, + "BackupPartitionDescriptionOptionalBodyParam": { + "name": "BackupPartitionDescription", + "in": "body", + "required": false, + "x-ms-parameter-location": "method", + "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.", + "schema": { + "$ref": "#/definitions/BackupPartitionDescription" + } + }, + "BackupTimeoutOptionalQueryParam": { + "name": "BackupTimeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.", + "default": 10 + }, + "LatestOptionalQueryParam": { + "name": "Latest", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.", + "required": false, + "default": false + }, + "StartDateTimeFilterOptionalQueryParam": { + "name": "StartDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." + }, + "EndDateTimeFilterOptionalQueryParam": { + "name": "EndDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." + }, + "GetBackupByStorageQueryDescriptionRequiredBodyParam": { + "name": "GetBackupByStorageQueryDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the filters and backup storage details to be used for enumerating backups.", + "schema": { + "$ref": "#/definitions/GetBackupByStorageQueryDescription" + } + }, + "RepairTaskApproveDescriptionRequiredBodyParam": { + "name": "RepairTaskApproveDescription", + "in": "body", + "description": "Describes the repair task to be approved.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskApproveDescription" + } + }, + "RepairTaskCancelDescriptionRequiredBodyParam": { + "name": "RepairTaskCancelDescription", + "in": "body", + "description": "Describes the repair task to be cancelled.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskCancelDescription" + } + }, + "RepairTaskDeleteDescriptionRequiredBodyParam": { + "name": "RepairTaskDeleteDescription", + "in": "body", + "description": "Describes the repair task to be deleted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskDeleteDescription" + } + }, + "RepairTaskExecutorFilterOptionalQueryParam": { + "name": "ExecutorFilter", + "description": "The name of the repair executor whose claimed tasks should be included in the list.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskIdFilterOptionalQueryParam": { + "name": "TaskIdFilter", + "description": "The repair task ID prefix to be matched.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskRequiredBodyParam": { + "name": "RepairTask", + "in": "body", + "description": "Describes the repair task to be created or updated.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskStateFilterOptionalQueryParam": { + "name": "StateFilter", + "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": { + "name": "RepairTaskUpdateHealthPolicyDescription", + "in": "body", + "description": "Describes the repair task healthy policy to be updated.", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription" + } + }, + "UploadSessionIdRequiredQueryParam": { + "name": "session-id", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true, + "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed." + }, + "UploadFileChunkContentRangeHeaderParam": { + "name": "Content-Range", + "in": "header", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes." + }, + "TailOptionalQueryParam": { + "name": "Tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs." + }, + "ChaosScheduleRequiredBodyParam": { + "name": "ChaosSchedule", + "in": "body", + "description": "Describes the schedule used by Chaos.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "StartTimeUtcRequiredQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EndTimeUtcRequiredQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EventsTypesFilterOptionalQueryParam": { + "name": "EventsTypesFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response." + }, + "ExcludeAnalysisEventsOptionalQueryParam": { + "name": "ExcludeAnalysisEvents", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the retrieval of AnalysisEvents if true is passed." + }, + "SkipCorrelationLookupOptionalQueryParam": { + "name": "SkipCorrelationLookup", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated." + }, + "EventInstanceIdRequiredPathParam": { + "name": "eventInstanceId", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The EventInstanceId." + }, + "PreviousOptionalQueryParam": { + "name": "Previous", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.", + "required": false, + "default": false + }, + "ApplicationResourceNameRequiredPathParam": { + "name": "applicationResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric application resource name." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating an application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ReplicaNameRequiredPathParam": { + "name": "replicaName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric replica name." + }, + "ServiceResourceNameRequiredPathParam": { + "name": "serviceResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric service resource name." + }, + "VolumeResourceNameRequiredPathParam": { + "name": "volumeResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric volume resource name." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json index 675b9377abe5..34104b25b26a 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json @@ -1,2111 +1,2111 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceFabricManagementClient", - "description": "Azure Service Fabric Resource Provider API Client", - "version": "2017-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/providers/Microsoft.ServiceFabric/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Lists all of the available Service Fabric resource provider API operations.", - "description": "Get the list of available Service Fabric resource provider API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "name": "api-version", - "in": "query", - "description": "The version of the Service Fabric resouce provider API", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}": { - "get": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationTypes_Get", - "summary": "Gets a Service Fabric application type name resource.", - "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application type": { - "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationTypes_Create", - "summary": "Creates or updates a Service Fabric application type name resource.", - "description": "Create or update a Service Fabric application type name resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application type name resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application type": { - "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationTypes_Delete", - "summary": "Deletes a Service Fabric application type name resource.", - "description": "Delete a Service Fabric application type name resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application type": { - "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes": { - "get": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationTypes_List", - "summary": "Gets the list of application type name resources created in the specified Service Fabric cluster resource.", - "description": "Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application type name resources": { - "$ref": "./examples/ApplicationTypeNameListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { - "get": { - "tags": [ - "ApplicationTypeVersion" - ], - "operationId": "ApplicationTypeVersions_Get", - "summary": "Gets a Service Fabric application type version resource.", - "description": "Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application type version": { - "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeVersionResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "ApplicationTypeVersion" - ], - "operationId": "ApplicationTypeVersions_Create", - "summary": "Creates or updates a Service Fabric application type version resource.", - "description": "Create or update a Service Fabric application type version resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application type version resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationTypeVersionResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application type version": { - "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ApplicationTypeVersionResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationTypeVersion" - ], - "operationId": "ApplicationTypeVersions_Delete", - "summary": "Deletes a Service Fabric application type version resource.", - "description": "Delete a Service Fabric application type version resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application type version": { - "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { - "get": { - "tags": [ - "ApplicationTypeVersion" - ], - "operationId": "ApplicationTypeVersions_List", - "summary": "Gets the list of application type version resources created in the specified Service Fabric application type name resource.", - "description": "Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application type version resources": { - "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeVersionResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_Get", - "summary": "Gets a Service Fabric application resource.", - "description": "Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application": { - "$ref": "./examples/ApplicationGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Application" - ], - "operationId": "Applications_Create", - "summary": "Creates or updates a Service Fabric application resource.", - "description": "Create or update a Service Fabric application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application with mininum parameters": { - "$ref": "./examples/ApplicationPutOperation_example_min.json" - }, - "Put an application with maximum parameters": { - "$ref": "./examples/ApplicationPutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ApplicationResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "tags": [ - "Application" - ], - "operationId": "Applications_Update", - "summary": "Updates a Service Fabric application resource.", - "description": "Update a Service Fabric application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application resource for patch operations.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationResourceUpdate" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Patch an application": { - "$ref": "./examples/ApplicationPatchOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ApplicationResourceUpdate" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Application" - ], - "operationId": "Applications_Delete", - "summary": "Deletes a Service Fabric application resource.", - "description": "Delete a Service Fabric application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application": { - "$ref": "./examples/ApplicationDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Applications_List", - "summary": "Gets the list of application resources created in the specified Service Fabric cluster resource.", - "description": "Gets all application resources created or in the process of being created in the Service Fabric cluster resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application resources": { - "$ref": "./examples/ApplicationListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { - "get": { - "tags": [ - "Service" - ], - "operationId": "Services_Get", - "summary": "Gets a Service Fabric service resource.", - "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a service": { - "$ref": "./examples/ServiceGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Service" - ], - "operationId": "Services_Create", - "summary": "Creates or updates a Service Fabric service resource.", - "description": "Create or update a Service Fabric service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The service resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put a service with mininum parameters": { - "$ref": "./examples/ServicePutOperation_example_min.json" - }, - "Put a service with maximum parameters": { - "$ref": "./examples/ServicePutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "tags": [ - "Service" - ], - "operationId": "Services_Update", - "summary": "Updates a Service Fabric service resource.", - "description": "Update a Service Fabric service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The service resource for patch operations.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResourceUpdate" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Patch a service": { - "$ref": "./examples/ServicePatchOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServiceResourceUpdate" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Service" - ], - "operationId": "Services_Delete", - "summary": "Deletes a Service Fabric service resource.", - "description": "Delete a Service Fabric service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete a service": { - "$ref": "./examples/ServiceDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services": { - "get": { - "tags": [ - "Service" - ], - "operationId": "Services_List", - "summary": "Gets the list of service resources created in the specified Service Fabric application resource.", - "description": "Gets all service resources created or in the process of being created in the Service Fabric application resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of service resources": { - "$ref": "./examples/ServiceListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServiceResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - } - }, - "definitions": { - "ApplicationHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n", - "default": 0 - }, - "DefaultServiceTypeHealthPolicy": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The health policy used by default to evaluate the health of a service type." - }, - "ServiceTypeHealthPolicyMap": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMap", - "description": "The map with service type health policy per service type name. The map is empty by default." - } - } - }, - "ApplicationMetricDescription": { - "type": "object", - "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "MaximumCapacity": { - "type": "integer", - "format": "int64", - "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" - }, - "ReservationCapacity": { - "type": "integer", - "format": "int64", - "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" - }, - "TotalApplicationCapacity": { - "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n", - "type": "integer", - "format": "int64" - } - } - }, - "ApplicationMetricDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationMetricDescription" - }, - "description": "List of application capacity metric description." - }, - "ApplicationTypeName": { - "type": "string", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "The version of the application type as defined in the application manifest." - }, - "ForceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", - "default": false - }, - "HealthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H10M0S" - }, - "HealthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "HealthCheckWaitDuration": { - "type": "string", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "0" - }, - "UpgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeReplicaSetCheckTimeout": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", - "default": 42949672925 - }, - "ServiceKind": { - "type": "string", - "description": "The kind of service (Stateless or Stateful).", - "enum": [ - "Invalid", - "Stateless", - "Stateful" - ], - "x-ms-enum": { - "name": "ServiceKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Stateless", - "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." - }, - { - "value": "Stateful", - "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." - } - ] - } - }, - "ServiceName": { - "type": "string", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "CorrelationSchemeList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "ServiceCorrelationDescription": { - "type": "object", - "description": "Creates a particular correlation between services.", - "required": [ - "Scheme", - "ServiceName" - ], - "properties": { - "Scheme": { - "$ref": "#/definitions/ServiceCorrelationScheme", - "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName", - "description": "The name of the service that the correlation relationship is established with." - } - } - }, - "ServiceCorrelationScheme": { - "type": "string", - "description": "The service correlation scheme.", - "enum": [ - "Invalid", - "Affinity", - "AlignedAffinity", - "NonAlignedAffinity" - ], - "x-ms-enum": { - "name": "ServiceCorrelationScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "An invalid correlation scheme. Cannot be used. The value is zero." - }, - { - "value": "Affinity", - "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." - }, - { - "value": "AlignedAffinity", - "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." - }, - { - "value": "NonAlignedAffinity", - "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." - } - ] - } - }, - "ServiceLoadMetricsList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceLoadMetricDescription" - }, - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServiceLoadMetricDescription": { - "type": "object", - "description": "Specifies a metric to load balance a service during runtime.", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." - }, - "Weight": { - "$ref": "#/definitions/ServiceLoadMetricWeight", - "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." - }, - "PrimaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." - }, - "SecondaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." - }, - "DefaultLoad": { - "type": "integer", - "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." - } - } - }, - "ServiceLoadMetricWeight": { - "type": "string", - "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "ServiceLoadMetricWeight", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Disables resource balancing for this metric. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the metric weight of the service load as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the metric weight of the service load as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the metric weight of the service load as High. The value is 3." - } - ] - } - }, - "ServicePlacementPoliciesList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "ServicePlacementPolicyDescription": { - "type": "object", - "discriminator": "Type", - "description": "Describes the policy to be used for placement of a Service Fabric service.", - "required": [ - "Type" - ], - "properties": { - "Type": { - "$ref": "#/definitions/ServicePlacementPolicyType", - "description": "The type of placement policy for a service fabric service. Following are the possible values." - } - } - }, - "ServicePlacementPolicyType": { - "type": "string", - "description": "The type of placement policy for a service fabric service. Following are the possible values.", - "enum": [ - "Invalid", - "InvalidDomain", - "RequiredDomain", - "PreferredPrimaryDomain", - "RequiredDomainDistribution", - "NonPartiallyPlaceService" - ], - "x-ms-enum": { - "name": "ServicePlacementPolicyType", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "InvalidDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." - }, - { - "value": "RequiredDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." - }, - { - "value": "PreferredPrimaryDomain", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." - }, - { - "value": "RequiredDomainDistribution", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." - }, - { - "value": "NonPartiallyPlaceService", - "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." - } - ] - } - }, - "PartitionScheme": { - "type": "string", - "description": "Enumerates the ways that a service can be partitioned.", - "enum": [ - "Invalid", - "Singleton", - "UniformInt64Range", - "Named" - ], - "x-ms-enum": { - "name": "PartitionScheme", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Singleton", - "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." - }, - { - "value": "UniformInt64Range", - "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." - }, - { - "value": "Named", - "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" - } - ] - } - }, - "PartitionSchemeDescription": { - "type": "object", - "discriminator": "PartitionScheme", - "description": "Describes how the service is partitioned.", - "required": [ - "PartitionScheme" - ], - "properties": { - "PartitionScheme": { - "$ref": "#/definitions/PartitionScheme", - "description": "Specifies how the service is partitioned." - } - } - }, - "NamedPartitionSchemeDescription": { - "description": "Describes the named partition scheme of the service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "NamedPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Named", - "required": [ - "Count", - "Names" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "Names": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." - } - } - }, - "SingletonPartitionSchemeDescription": { - "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "SingletonPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "UniformInt64RangePartitionSchemeDescription": { - "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "UniformInt64RangePartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "UniformInt64Range", - "required": [ - "Count", - "LowKey", - "HighKey" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "LowKey": { - "type": "string", - "description": "String indicating the lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" - }, - "HighKey": { - "type": "string", - "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" - } - } - }, - "MoveCost": { - "type": "string", - "description": "Specifies the move cost for the service.", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "MoveCost", - "modelAsString": true, - "values": [ - { - "value": "Zero", - "description": "Zero move cost. This value is zero." - }, - { - "value": "Low", - "description": "Specifies the move cost of the service as Low. The value is 1." - }, - { - "value": "Medium", - "description": "Specifies the move cost of the service as Medium. The value is 2." - }, - { - "value": "High", - "description": "Specifies the move cost of the service as High. The value is 3." - } - ] - } - }, - "ApplicationParameterList": { - "type": "object", - "description": "List of application parameters with overridden values from their default values specified in the application manifest.", - "additionalProperties": { - "type": "string" - } - }, - "ApplicationResource": { - "description": "The application resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationResourceProperties", - "description": "The application resource properties." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationResourceList": { - "description": "The list of application resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationResource" - } - } - } - }, - "ApplicationResourceProperties": { - "description": "The application resource properties.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationResourceUpdateProperties" - } - ], - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "typeName": { - "$ref": "#/definitions/ApplicationTypeName", - "description": "The application type name as defined in the application manifest." - } - } - }, - "ApplicationResourceUpdate": { - "description": "The application resource for patch operations.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationResourceUpdateProperties", - "description": "The application resource properties for patch operations." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationResourceUpdateProperties": { - "description": "The application resource properties for patch operations.", - "properties": { - "typeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion", - "description": "The version of the application type as defined in the application manifest." - }, - "parameters": { - "$ref": "#/definitions/ApplicationParameterList", - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "upgradePolicy": { - "$ref": "#/definitions/ApplicationUpgradePolicy", - "description": "Describes the policy for a monitored application upgrade." - }, - "minimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", - "minimum": 0 - }, - "maximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", - "minimum": 0, - "default": 0 - }, - "removeApplicationCapacity": { - "type": "boolean", - "description": "Remove the current application capacity settings." - }, - "metrics": { - "$ref": "#/definitions/ApplicationMetricDescriptionList", - "description": "List of application capacity metric description." - } - } - }, - "ApplicationTypeParameterList": { - "type": "object", - "description": "List of application type parameters that can be overridden when creating or updating the application.", - "additionalProperties": { - "type": "string" - } - }, - "ApplicationTypeResourceProperties": { - "description": "The application type name properties", - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response." - } - } - }, - "ApplicationTypeResource": { - "description": "The application type name resource", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationTypeResourceProperties", - "description": "The application type name properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationTypeResourceList": { - "description": "The list of application type names.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationTypeResource" - } - } - } - }, - "ApplicationTypeVersionResource": { - "description": "An application type version resource for the specified application type name resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationTypeVersionResourceProperties", - "description": "The properties of the application type version resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationTypeVersionResourceList": { - "description": "The list of application type version resources for the specified application type name resource.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationTypeVersionResource" - } - } - } - }, - "ApplicationTypeVersionResourceProperties": { - "description": "The properties of the application type version resource.", - "required": [ - "appPackageUrl" - ], - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "appPackageUrl": { - "type": "string", - "description": "The URL to the application package" - }, - "defaultParameterList": { - "readOnly": true, - "$ref": "#/definitions/ApplicationTypeParameterList", - "description": "List of application type parameters that can be overridden when creating or updating the application." - } - } - }, - "ApplicationUpgradePolicy": { - "description": "Describes the policy for a monitored application upgrade.", - "properties": { - "upgradeReplicaSetCheckTimeout": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." - }, - "forceRestart": { - "$ref": "#/definitions/ForceRestart", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "rollingUpgradeMonitoringPolicy": { - "$ref": "#/definitions/RollingUpgradeMonitoringPolicy", - "description": "The policy used for monitoring the application upgrade" - }, - "applicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" - } - } - }, - "AvailableOperationDisplay": { - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider." - }, - "resource": { - "type": "string", - "description": "The resource on which the operation is performed" - }, - "operation": { - "type": "string", - "description": "The operation that can be performed." - }, - "description": { - "type": "string", - "description": "Operation description" - } - }, - "description": "Operation supported by Service Fabric resource provider" - }, - "OperationListResult": { - "properties": { - "value": { - "type": "array", - "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", - "items": { - "$ref": "#/definitions/OperationResult" - } - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - }, - "description": "Describes the result of the request to list Service Fabric operations." - }, - "OperationResult": { - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "$ref": "#/definitions/AvailableOperationDisplay", - "description": "The object that represents the operation." - }, - "origin": { - "type": "string", - "description": "Origin result" - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Available operation list result" - }, - "ProxyResource": { - "properties": { - "id": { - "type": "string", - "description": "Azure resource identifier.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Azure resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Azure resource type.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Azure resource location.", - "x-ms-mutability": [ - "create", - "read" - ] - } - }, - "description": "The resource model definition for proxy-only resource.", - "x-ms-azure-resource": true - }, - "RollingUpgradeMonitoringPolicy": { - "description": "The policy used for monitoring the application upgrade", - "properties": { - "healthCheckWaitDuration": { - "$ref": "#/definitions/HealthCheckWaitDuration", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "healthCheckStableDuration": { - "$ref": "#/definitions/HealthCheckStableDuration", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "healthCheckRetryTimeout": { - "$ref": "#/definitions/HealthCheckRetryTimeout", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "upgradeTimeout": { - "$ref": "#/definitions/UpgradeTimeout", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - }, - "upgradeDomainTimeout": { - "$ref": "#/definitions/UpgradeDomainTimeout", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." - } - } - }, - "ServiceResource": { - "description": "The service resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceResourceProperties", - "description": "The service resource properties." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ServiceResourceList": { - "description": "The list of service resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResource" - } - } - } - }, - "ServiceResourceProperties": { - "description": "The service resource properties.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourcePropertiesBase" - } - ], - "required": [ - "serviceKind" - ], - "discriminator": "serviceKind", - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "serviceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - }, - "serviceTypeName": { - "type": "string", - "description": "The name of the service type" - }, - "partitionDescription": { - "$ref": "#/definitions/PartitionSchemeDescription", - "description": "Describes how the service is partitioned." - } - } - }, - "ServiceResourcePropertiesBase": { - "description": "The common service resource properties.", - "properties": { - "placementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "correlationScheme": { - "$ref": "#/definitions/CorrelationSchemeList", - "description": "A list that describes the correlation of the service with other services." - }, - "serviceLoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList", - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "servicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList", - "description": "A list that describes the correlation of the service with other services." - }, - "defaultMoveCost": { - "$ref": "#/definitions/MoveCost", - "description": "Specifies the move cost for the service." - } - } - }, - "ServiceResourceUpdate": { - "description": "The service resource for patch operations.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceResourceUpdateProperties", - "description": "The service resource properties for patch operations." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ServiceResourceUpdateProperties": { - "description": "The service resource properties for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourcePropertiesBase" - } - ], - "required": [ - "serviceKind" - ], - "discriminator": "serviceKind", - "properties": { - "serviceKind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of service (Stateless or Stateful)." - } - } - }, - "StatefulServiceProperties": { - "description": "The properties of a stateful service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourceProperties" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "hasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - }, - "targetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "minReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "replicaRestartWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "quorumLossWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "standByReplicaKeepDuration": { - "type": "string", - "format": "date-time", - "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." - } - } - }, - "StatefulServiceUpdateProperties": { - "description": "The properties of a stateful service resource for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourceUpdateProperties" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "targetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "minReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "replicaRestartWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "quorumLossWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "standByReplicaKeepDuration": { - "type": "string", - "format": "date-time", - "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." - } - } - }, - "StatelessServiceProperties": { - "description": "The properties of a stateless service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourceProperties" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "instanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "StatelessServiceUpdateProperties": { - "description": "The properties of a stateless service resource for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServiceResourceUpdateProperties" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "instanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "ErrorModel": { - "properties": { - "error": { - "$ref": "#/definitions/ErrorModelError", - "description": "The error details." - } - }, - "description": "The structure of the error." - }, - "ErrorModelError": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "The error details." - }, - "ServiceTypeHealthPolicy": { - "type": "object", - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", - "properties": { - "maxPercentUnhealthyServices": { - "type": "integer", - "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", - "default": 0, - "minimum": 0, - "maximum": 100 - } - } - }, - "ServiceTypeHealthPolicyMap": { - "type": "object", - "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", - "additionalProperties": { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - } - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2017-07-01-preview\" for this specification.", - "required": true, - "type": "string", - "enum": [ - "2017-07-01-preview" - ], - "default": "2017-07-01-preview", - "x-ms-parameter-location": "client" - }, - "applicationName": { - "name": "applicationName", - "in": "path", - "description": "The name of the application resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "applicationTypeName": { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type name resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "clusterNameParameter": { - "name": "clusterName", - "in": "path", - "description": "The name of the cluster resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "serviceName": { - "name": "serviceName", - "in": "path", - "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The customer subscription identifier.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "version": { - "name": "version", - "in": "path", - "description": "The application type version.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2017-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resouce provider API", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Create", + "summary": "Creates or updates a Service Fabric application type name resource.", + "description": "Create or update a Service Fabric application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric application type name resource.", + "description": "Delete a Service Fabric application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric application type version resource.", + "description": "Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Create", + "summary": "Creates or updates a Service Fabric application type version resource.", + "description": "Create or update a Service Fabric application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric application type version resource.", + "description": "Delete a Service Fabric application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_List", + "summary": "Gets the list of application type version resources created in the specified Service Fabric application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric application resource.", + "description": "Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_Create", + "summary": "Creates or updates a Service Fabric application resource.", + "description": "Create or update a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with mininum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates a Service Fabric application resource.", + "description": "Update a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric application resource.", + "description": "Delete a Service Fabric application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_Create", + "summary": "Creates or updates a Service Fabric service resource.", + "description": "Create or update a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with mininum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Service" + ], + "operationId": "Services_Update", + "summary": "Updates a Service Fabric service resource.", + "description": "Update a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric service resource.", + "description": "Delete a Service Fabric service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_List", + "summary": "Gets the list of service resources created in the specified Service Fabric application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n", + "default": 0 + }, + "DefaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "ServiceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationMetricDescription": { + "type": "object", + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "MaximumCapacity": { + "type": "integer", + "format": "int64", + "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" + }, + "ReservationCapacity": { + "type": "integer", + "format": "int64", + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" + }, + "TotalApplicationCapacity": { + "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H10M0S" + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "0" + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", + "default": 42949672925 + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Invalid", + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServiceCorrelationDescription": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "An invalid correlation scheme. Cannot be used. The value is zero." + }, + { + "value": "Affinity", + "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." + }, + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." + } + ] + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "SecondaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "DefaultLoad": { + "type": "integer", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "description": "The type of placement policy for a service fabric service. Following are the possible values." + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." + } + ] + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Invalid", + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" + } + ] + } + }, + "PartitionSchemeDescription": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "Count", + "Names" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "Names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." + } + } + }, + "SingletonPartitionSchemeDescription": { + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "UniformInt64RangePartitionSchemeDescription": { + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "Count", + "LowKey", + "HighKey" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "LowKey": { + "type": "string", + "description": "String indicating the lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "description": "The application resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "The application resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + } + } + }, + "ApplicationResourceProperties": { + "description": "The application resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationResourceUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "typeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + } + } + }, + "ApplicationResourceUpdate": { + "description": "The application resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceUpdateProperties", + "description": "The application resource properties for patch operations." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceUpdateProperties": { + "description": "The application resource properties for patch operations.", + "properties": { + "typeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy", + "description": "Describes the policy for a monitored application upgrade." + }, + "minimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", + "minimum": 0 + }, + "maximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", + "minimum": 0, + "default": 0 + }, + "removeApplicationCapacity": { + "type": "boolean", + "description": "Remove the current application capacity settings." + }, + "metrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationTypeParameterList": { + "type": "object", + "description": "List of application type parameters that can be overridden when creating or updating the application.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationTypeResourceProperties": { + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeResource": { + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties", + "description": "The application type name properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + } + } + }, + "ApplicationTypeVersionResource": { + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties", + "description": "The properties of the application type version resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + }, + "defaultParameterList": { + "readOnly": true, + "$ref": "#/definitions/ApplicationTypeParameterList", + "description": "List of application type parameters that can be overridden when creating or updating the application." + } + } + }, + "ApplicationUpgradePolicy": { + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "upgradeReplicaSetCheckTimeout": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy", + "description": "The policy used for monitoring the application upgrade" + }, + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n" + } + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by Service Fabric resource provider" + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ProxyResource": { + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMonitoringPolicy": { + "description": "The policy used for monitoring the application upgrade", + "properties": { + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + } + }, + "ServiceResource": { + "description": "The service resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "The service resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + } + } + }, + "ServiceResourceProperties": { + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription", + "description": "Describes how the service is partitioned." + } + } + }, + "ServiceResourcePropertiesBase": { + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "A list that describes the correlation of the service with other services." + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "A list that describes the correlation of the service with other services." + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "Specifies the move cost for the service." + } + } + }, + "ServiceResourceUpdate": { + "description": "The service resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceUpdateProperties", + "description": "The service resource properties for patch operations." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceUpdateProperties": { + "description": "The service resource properties for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "serviceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + } + } + }, + "StatefulServiceProperties": { + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "StatefulServiceUpdateProperties": { + "description": "The properties of a stateful service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceUpdateProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "targetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "StatelessServiceProperties": { + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "StatelessServiceUpdateProperties": { + "description": "The properties of a stateless service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceUpdateProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ErrorModel": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2017-07-01-preview\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2017-07-01-preview" + ], + "default": "2017-07-01-preview", + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationDeleteOperation_example.json index 5c0d202adecb..188090a759a6 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationDeleteOperation_example.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview" - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2017-07-01-preview" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2017-07-01-preview" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationGetOperation_example.json index cd08c3ff98e1..c3909b3f7d5c 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationGetOperation_example.json @@ -1,62 +1,62 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502180261859\"", - "properties": { - "provisioningState": "Updating", - "typeName": "myAppType", - "typeVersion": "1.0", - "parameters": { - "param1": "value1" - }, - "upgradePolicy": { - "applicationHealthPolicy": { - "considerWarningAsError": true, - "maxPercentUnhealthyDeployedApplications": 0, - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0, - "maxPercentUnhealthyPartitionsPerService": 0, - "maxPercentUnhealthyReplicasPerPartition": 0 - } - }, - "rollingUpgradeMonitoringPolicy": { - "failureAction": "Rollback", - "healthCheckRetryTimeout": "00:10:00", - "healthCheckWaitDuration": "00:02:00", - "healthCheckStableDuration": "00:05:00", - "upgradeDomainTimeout": "1.06:00:00", - "upgradeTimeout": "01:00:00" - }, - "upgradeReplicaSetCheckTimeout": "01:00:00", - "forceRestart": false - }, - "maximumNodes": 3, - "minimumNodes": 1, - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261859\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationListOperation_example.json index 6e0e67e41bc1..d2f603307dc7 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationListOperation_example.json @@ -1,40 +1,40 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502180261858\"", - "properties": { - "provisioningState": "Updating", - "typeName": "myAppType", - "typeVersion": "1.0", - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261858\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPatchOperation_example.json index 418f7dcbf15c..411965612061 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPatchOperation_example.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "properties": { - "typeName": "myAppType", - "typeVersion": "1.0", - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/a553eb63-c332-40df-8ace-eb8d34a9b298?api-version=2017-07-01-preview" - }, - "body": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502180261858\"", - "properties": { - "provisioningState": "Updating", - "typeName": "myAppType", - "typeVersion": "1.0", - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/a553eb63-c332-40df-8ace-eb8d34a9b298?api-version=2017-07-01-preview" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261858\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_max.json index f18a4faab7bf..70cc3fa9823c 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_max.json @@ -1,111 +1,111 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "properties": { - "typeName": "myAppType", - "typeVersion": "1.0", - "parameters": { - "param1": "value1" - }, - "upgradePolicy": { - "applicationHealthPolicy": { - "considerWarningAsError": true, - "maxPercentUnhealthyDeployedApplications": 0, - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0, - "maxPercentUnhealthyPartitionsPerService": 0, - "maxPercentUnhealthyReplicasPerPartition": 0 - } - }, - "rollingUpgradeMonitoringPolicy": { - "failureAction": "Rollback", - "healthCheckRetryTimeout": "00:10:00", - "healthCheckWaitDuration": "00:02:00", - "healthCheckStableDuration": "00:05:00", - "upgradeDomainTimeout": "1.06:00:00", - "upgradeTimeout": "01:00:00" - }, - "upgradeReplicaSetCheckTimeout": "01:00:00", - "forceRestart": false - }, - "maximumNodes": 3, - "minimumNodes": 1, - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2017-07-01-preview" - }, - "body": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502180261859\"", - "properties": { - "provisioningState": "Updating", - "typeName": "myAppType", - "typeVersion": "1.0", - "parameters": { - "param1": "value1" - }, - "upgradePolicy": { - "applicationHealthPolicy": { - "considerWarningAsError": true, - "maxPercentUnhealthyDeployedApplications": 0, - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0, - "maxPercentUnhealthyPartitionsPerService": 0, - "maxPercentUnhealthyReplicasPerPartition": 0 - } - }, - "rollingUpgradeMonitoringPolicy": { - "failureAction": "Rollback", - "healthCheckRetryTimeout": "00:10:00", - "healthCheckWaitDuration": "00:02:00", - "healthCheckStableDuration": "00:05:00", - "upgradeDomainTimeout": "1.06:00:00", - "upgradeTimeout": "01:00:00" - }, - "upgradeReplicaSetCheckTimeout": "01:00:00", - "forceRestart": false - }, - "maximumNodes": 3, - "minimumNodes": 1, - "removeApplicationCapacity": false, - "metrics": [ - { - "name": "metric1", - "reservationCapacity": 1, - "maximumCapacity": 3, - "totalApplicationCapacity": 5 - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2017-07-01-preview" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261859\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "1.06:00:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": "01:00:00", + "forceRestart": false + }, + "maximumNodes": 3, + "minimumNodes": 1, + "removeApplicationCapacity": false, + "metrics": [ + { + "name": "metric1", + "reservationCapacity": 1, + "maximumCapacity": 3, + "totalApplicationCapacity": 5 + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_min.json index 898c9207dc9e..fae70a180d68 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationPutOperation_example_min.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "properties": { - "typeName": "myAppType", - "typeVersion": "1.0", - "removeApplicationCapacity": false - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2017-07-01-preview" - }, - "body": { - "type": "applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502180261857\"", - "properties": { - "provisioningState": "Updating", - "typeName": "myAppType", - "typeVersion": "1.0", - "removeApplicationCapacity": false - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "properties": { + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2017-07-01-preview" + }, + "body": { + "type": "applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502180261857\"", + "properties": { + "provisioningState": "Updating", + "typeName": "myAppType", + "typeVersion": "1.0", + "removeApplicationCapacity": false + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json index 8d31d34a556d..71416fa83605 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "api-version": "2017-07-01-preview" - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2017-07-01-preview" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2017-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2017-07-01-preview" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json index b9739724d7b5..9bd943ab9d0f 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameGetOperation_example.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "applicationTypes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502174844831\"", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameListOperation_example.json index 8daf4e179ad9..a030ccd5aa0c 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNameListOperation_example.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "applicationTypes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502174844831\"", - "properties": { - "provisioningState": "Succeeded" - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json index 044cfd868ee4..bdbbf0ee8f89 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeNamePutOperation_example.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "applicationTypes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", - "name": "myCluster", - "tags": {} - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "applicationTypes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502174844831\"", - "properties": { - "provisioningState": "Succeeded" - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {} + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "applicationTypes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502174844831\"", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json index b0e24551aeae..5b4942e58ba5 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "version": "1.0", - "api-version": "2017-07-01-preview" - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2017-07-01-preview" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2017-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2017-07-01-preview" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json index f654769f52b1..40d6e958aa42 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionGetOperation_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "version": "1.0", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "versions", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502176040417\"", - "properties": { - "provisioningState": "Updating", - "appPackageUrl": "http://fakelink.test.com/MyAppType", - "defaultParameterList": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json index bfa9ff397ffb..a836490247b9 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionListOperation_example.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "versions", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502176040417\"", - "properties": { - "provisioningState": "Updating", - "appPackageUrl": "http://fakelink.test.com/MyAppType", - "defaultParameterList": {} - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json index 361c137d347f..792dcadaafa3 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ApplicationTypeVersionPutOperation_example.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationTypeName": "myAppType", - "version": "1.0", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "versions", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", - "name": "myCluster", - "tags": {}, - "properties": { - "appPackageUrl": "http://fakelink.test.com/MyAppType" - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2017-07-01-preview" - }, - "body": { - "type": "versions", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502176040417\"", - "properties": { - "provisioningState": "Updating", - "appPackageUrl": "http://fakelink.test.com/MyAppType", - "defaultParameterList": {} - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2017-07-01-preview" + }, + "body": { + "type": "versions", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502176040417\"", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType", + "defaultParameterList": {} + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterDeleteOperation_example.json index 39a7c12472ff..a31f761f5d7d 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterDeleteOperation_example.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {} - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json index e5dc282baa16..ecc7972d6041 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterGetOperation_example.json @@ -1,145 +1,145 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100, - "applicationHealthPolicies": { - "myAppHealthPolicy": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 100 - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "myAppDeltaHealthPolicy": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - }, - "serivceTypeDeltaHealthPolicies": { - "mySvcTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [ - "RepairManager", - "DnsService" - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100, + "applicationHealthPolicies": { + "myAppHealthPolicy": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 100 + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "myAppDeltaHealthPolicy": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + }, + "serivceTypeDeltaHealthPolicies": { + "mySvcTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService" + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json index b6b171f5684e..0b1eed13c1a6 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListByResourceGroupOperation_example.json @@ -1,235 +1,235 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100, - "applicationHealthPolicies": { - "myAppHealthPolicy": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 100 - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "myAppDeltaHealthPolicy": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - }, - "serivceTypeDeltaHealthPolicies": { - "mySvcTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [ - "RepairManager", - "DnsService" - ] - } - }, - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", - "name": "myCluster2", - "tags": {}, - "etag": "W/\"636462502164040075\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", - "clusterCodeVersion": "6.0.127.1", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", - "healthCheckWaitDuration": "00:05:00", - "healthCheckStableDuration": "00:05:00", - "healthCheckRetryTimeout": "00:45:00", - "upgradeTimeout": "12:00:00", - "upgradeDomainTimeout": "02:00:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "linux", - "reliabilityLevel": "Silver", - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.127.1", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Linux" - } - ], - "addonFeatures": [ - "RepairManager" - ] - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100, + "applicationHealthPolicies": { + "myAppHealthPolicy": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 100 + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "myAppDeltaHealthPolicy": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + }, + "serivceTypeDeltaHealthPolicies": { + "mySvcTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.0.127.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "linux", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.127.1", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json index a803d503efdf..44412ea25822 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterListOperation_example.json @@ -1,234 +1,234 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100, - "applicationHealthPolicies": { - "myAppHealthPolicy": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 100 - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "myAppDeltaHealthPolicy": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - }, - "serivceTypeDeltaHealthPolicies": { - "mySvcTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [ - "RepairManager", - "DnsService" - ] - } - }, - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", - "name": "myCluster2", - "tags": {}, - "etag": "W/\"636462502164040075\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", - "clusterCodeVersion": "6.0.127.1", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", - "healthCheckWaitDuration": "00:05:00", - "healthCheckStableDuration": "00:05:00", - "healthCheckRetryTimeout": "00:45:00", - "upgradeTimeout": "12:00:00", - "upgradeDomainTimeout": "02:00:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "linux", - "reliabilityLevel": "Silver", - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.127.1", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Linux" - } - ], - "addonFeatures": [ - "RepairManager" - ] - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100, + "applicationHealthPolicies": { + "myAppHealthPolicy": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 100 + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "myAppDeltaHealthPolicy": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + }, + "serivceTypeDeltaHealthPolicies": { + "mySvcTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.0.127.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "linux", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.127.1", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json index 0a1821d80ad6..44be56e97c45 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPatchOperation_example.json @@ -1,166 +1,166 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": { - "a": "b" - }, - "properties": { - "clusterState": "Default", - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - }, - { - "name": "testnt1", - "clientConnectionEndpointPort": 0, - "httpGatewayEndpointPort": 0, - "applicationPorts": { - "startPort": 1000, - "endPort": 2000 - }, - "ephemeralPorts": { - "startPort": 3000, - "endPort": 4000 - }, - "isPrimary": false, - "vmInstanceCount": 3, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Bronze", - "upgradeMode": "Default", - "addonFeatures": [] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2017-07-01-privatepreview" - }, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": { - "a": "b" - }, - "etag": "W/\"636462502169240744\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", - "healthCheckWaitDuration": "00:05:00", - "healthCheckStableDuration": "00:05:00", - "healthCheckRetryTimeout": "00:45:00", - "upgradeTimeout": "12:00:00", - "upgradeDomainTimeout": "02:00:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - }, - { - "name": "testnt1", - "clientConnectionEndpointPort": 0, - "httpGatewayEndpointPort": 0, - "applicationPorts": { - "startPort": 1000, - "endPort": 2000 - }, - "ephemeralPorts": { - "startPort": 3000, - "endPort": 4000 - }, - "isPrimary": false, - "vmInstanceCount": 3, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Bronze", - "upgradeMode": "Automatic", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "properties": { + "clusterState": "Default", + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Default", + "addonFeatures": [] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2017-07-01-privatepreview" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240744\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json index 0c6b0ad396e0..890bf57aeb58 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_max.json @@ -1,269 +1,269 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "properties": { - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "Default", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "certificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100, - "applicationHealthPolicies": { - "myAppHealthPolicy": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 100 - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "myAppDeltaHealthPolicy": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - }, - "serivceTypeDeltaHealthPolicies": { - "mySvcTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "addonFeatures": [ - "RepairManager", - "DnsService" - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2017-07-01-privatepreview" - }, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100, - "applicationHealthPolicies": { - "myAppHealthPolicy": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 100 - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "myAppDeltaHealthPolicy": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - }, - "serivceTypeDeltaHealthPolicies": { - "mySvcTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 100 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificate": { - "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", - "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [ - "RepairManager", - "DnsService" - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "Default", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "certificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100, + "applicationHealthPolicies": { + "myAppHealthPolicy": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 100 + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "myAppDeltaHealthPolicy": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + }, + "serivceTypeDeltaHealthPolicies": { + "mySvcTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "addonFeatures": [ + "RepairManager", + "DnsService" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2017-07-01-privatepreview" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100, + "applicationHealthPolicies": { + "myAppHealthPolicy": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 100 + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "myAppDeltaHealthPolicy": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + }, + "serivceTypeDeltaHealthPolicies": { + "mySvcTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 100 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificate": { + "thumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A", + "thumbprintSecondary": "361A93445450CC8F2FF747F74500E8044942DAFD", + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService" + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json index 237b0db961bd..9d0bba0ecfa0 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterPutOperation_example_min.json @@ -1,144 +1,144 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "properties": { - "clusterState": "Default", - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Silver", - "upgradeMode": "Automatic" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240743\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.0.219.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "overrideUserUpgradePolicy": false, - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", - "healthCheckWaitDuration": "00:05:00", - "healthCheckStableDuration": "00:05:00", - "healthCheckRetryTimeout": "00:45:00", - "upgradeTimeout": "12:00:00", - "upgradeDomainTimeout": "02:00:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Silver", - "upgradeMode": "Automatic", - "availableClusterVersions": [ - { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "clusterState": "Default", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240743\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.0.219.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "overrideUserUpgradePolicy": false, + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGetByEnvironment_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGetByEnvironment_example.json index d5e5b0d4171e..b0b5965b2ff2 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGetByEnvironment_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGetByEnvironment_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "environment": "Windows", - "clusterVersion": "6.0.219.9494", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", - "name": "6.0.219.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "6.0.219.9494", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", + "name": "6.0.219.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGet_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGet_example.json index 752dd950450b..7f7c9582bd8f 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGet_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsGet_example.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "clusterVersion": "6.0.219.9494", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", - "name": "6.0.219.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "6.0.219.9494", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", + "name": "6.0.219.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsListByEnvironment.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsListByEnvironment.json index 393fb64fe5ea..9044e9331da1 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsListByEnvironment.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsListByEnvironment.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "environment": "Windows", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", - "name": "6.0.219.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", + "name": "6.0.219.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsList_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsList_example.json index a5807fbf580e..91aba9988cfb 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsList_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ClusterVersionsList_example.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", - "name": "6.0.219.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.0.219.9494", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Windows" - } - }, - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.0.127.1", - "name": "6.0.127.1", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.0.127.1", - "supportExpiryUtc": "9999-12-31T23:59:59.9999999", - "environment": "Linux" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.0.219.9494", + "name": "6.0.219.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.0.219.9494", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Windows" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.0.127.1", + "name": "6.0.127.1", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.0.127.1", + "supportExpiryUtc": "9999-12-31T23:59:59.9999999", + "environment": "Linux" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceDeleteOperation_example.json index 6169d94df676..a4c378e98429 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceDeleteOperation_example.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "serviceName": "myService", - "api-version": "2017-07-01-preview" - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2017-07-01-preview" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2017-07-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2017-07-01-preview" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceGetOperation_example.json index ad6e56e09a1a..39d17891ef66 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceGetOperation_example.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "serviceName": "myService", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502183671258\"", - "properties": { - "provisioningState": "Updating", - "serviceKind": "Stateless", - "placementConstraints": "NodeType==frontend", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ], - "servicePlacementPolicies": [], - "defaultMoveCost": "Medium", - "instanceCount": 5 - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671258\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5 + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceListOperation_example.json index 2a76bfc46e2b..f003d822a192 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServiceListOperation_example.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "api-version": "2017-07-01-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502183671257\"", - "properties": { - "provisioningState": "Updating", - "serviceKind": "Stateless", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ], - "instanceCount": 1 - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2017-07-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671257\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1 + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePatchOperation_example.json index 32788fffa1e0..a39a552e3bcb 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePatchOperation_example.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "serviceName": "myService", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "properties": { - "serviceKind": "Stateless", - "serviceTypeName": "myServiceType", - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4dde8d8b-b6b2-4c56-99c6-9b83932bb09a?api-version=2017-07-01-preview" - }, - "body": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502183671257\"", - "properties": { - "provisioningState": "Updating", - "serviceKind": "Stateless", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ], - "instanceCount": 1 - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4dde8d8b-b6b2-4c56-99c6-9b83932bb09a?api-version=2017-07-01-preview" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671257\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_max.json index 260bb8d21b67..5a1fa81e5e07 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_max.json @@ -1,74 +1,74 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "serviceName": "myService", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "properties": { - "serviceKind": "Stateless", - "placementConstraints": "NodeType==frontend", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ], - "correlationScheme": [ - { - "serviceName": "fabric:/app1/app1~svc1", - "scheme": "Affinity" - } - ], - "servicePlacementPolicies": [], - "defaultMoveCost": "Medium", - "instanceCount": 5 - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2017-07-01-preview" - }, - "body": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502183671258\"", - "properties": { - "provisioningState": "Updating", - "serviceKind": "Stateless", - "placementConstraints": "NodeType==frontend", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "serviceLoadMetrics": [ - { - "name": "metric1", - "weight": "Low" - } - ], - "servicePlacementPolicies": [], - "defaultMoveCost": "Medium", - "instanceCount": 5 - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "correlationScheme": [ + { + "serviceName": "fabric:/app1/app1~svc1", + "scheme": "Affinity" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5 + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2017-07-01-preview" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671258\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5 + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_min.json index eee76c1dbba9..5993f9b1c76e 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/examples/ServicePutOperation_example_min.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "applicationName": "myApp", - "serviceName": "myService", - "api-version": "2017-07-01-preview", - "parameters": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "properties": { - "serviceKind": "Stateless", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "instanceCount": 1 - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2017-07-01-preview" - }, - "body": { - "type": "services", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502183671256\"", - "properties": { - "provisioningState": "Updating", - "serviceKind": "Stateless", - "serviceTypeName": "myServiceType", - "partitionDescription": { - "partitionScheme": "Singleton" - }, - "instanceCount": 1 - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2017-07-01-preview", + "parameters": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2017-07-01-preview" + }, + "body": { + "type": "services", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502183671256\"", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json index ba1511381c4f..53af1c3ce0ed 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json @@ -1,3137 +1,3137 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceFabricManagementClient", - "description": "Azure Service Fabric Resource Provider API Client", - "version": "2017-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}": { - "put": { - "operationId": "Clusters_Create", - "summary": "Create a ServiceFabric cluster", - "description": "Create cluster resource\n", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "parameters", - "in": "body", - "description": "The cluster resource.", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "x-ms-parameter-location": "method" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "Put a cluster with min parameter": { - "$ref": "./examples/ClusterPutOperation_example_min.json" - }, - "Put a cluster with max parameter": { - "$ref": "./examples/ClusterPutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "200": { - "description": "OK - Put cluster successfully", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Accepted - Put request accepted; the operation will complete asynchronously." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Clusters_Delete", - "summary": "Delete cluster resource", - "description": "Delete cluster resource\n", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "Delete a cluster": { - "$ref": "./examples/ClusterDeleteOperation_example.json" - } - }, - "responses": { - "200": { - "description": "OK - cluster deleted successfully" - }, - "204": { - "description": "NoContent - cluster does not exist" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "get": { - "operationId": "Clusters_Get", - "summary": "Get cluster resource", - "description": "Get cluster resource\n", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "Get a cluster": { - "$ref": "./examples/ClusterGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "OK - Get cluster successfully", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "operationId": "Clusters_Update", - "summary": "Update cluster configuration", - "description": "Update cluster configuration\n", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters which contains the property value and property name which used to update the cluster configuration.", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdateParameters" - }, - "x-ms-parameter-location": "method" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Patch a cluster": { - "$ref": "./examples/ClusterPatchOperation_example.json" - } - }, - "responses": { - "200": { - "description": "OK - Cluster updated successfully", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Accepted - Update request accepted; the operation will complete asynchronously." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters": { - "get": { - "operationId": "Clusters_ListByResourceGroup", - "summary": "List cluster resource by resource group", - "description": "List cluster resource by resource group\n", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "List cluster by resource group": { - "$ref": "./examples/ClusterListByResourceGroupOperation_example.json" - } - }, - "responses": { - "200": { - "description": "OK - Get cluster successfully", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters": { - "get": { - "operationId": "Clusters_List", - "summary": "List cluster resource", - "description": "List cluster resource\n", - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ClusterListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "OK - Get cluster successfully", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}": { - "get": { - "operationId": "ClusterVersions_Get", - "summary": "Get cluster code versions", - "description": "Get cluster code versions by location\n", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/clusterVersion" - } - ], - "x-ms-examples": { - "Get cluster version": { - "$ref": "examples/ClusterVersionsGet_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "OK - Get cluster code versions successfully", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}": { - "get": { - "operationId": "ClusterVersions_GetByEnvironment", - "summary": "Get cluster code versions by environment", - "description": "Get cluster code versions by environment\n", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/environment" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/clusterVersion" - } - ], - "x-ms-examples": { - "Get cluster version by environment": { - "$ref": "examples/ClusterVersionsGetByEnvironment_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "OK - Get cluster code versions successfully", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions": { - "get": { - "operationId": "ClusterVersions_List", - "summary": "List cluster code versions by location", - "description": "List cluster code versions by location\n", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "List cluster versions": { - "$ref": "examples/ClusterVersionsList_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "OK - List cluster code versions successfully", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions": { - "get": { - "operationId": "ClusterVersions_ListByEnvironment", - "summary": "List cluster code versions by environment", - "description": "List cluster code versions by environment\n", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/environment" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "List cluster versions by environment": { - "$ref": "examples/ClusterVersionsListByEnvironment.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "OK - List cluster code versions successfully", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/providers/Microsoft.ServiceFabric/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Lists all of the available ServiceFabric Resource Manager REST API operations.", - "description": "", - "operationId": "Operations_List", - "parameters": [ - { - "name": "api-version", - "in": "query", - "description": "The version of the ServiceFabric resouce provider api", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}": { - "get": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationType_Get", - "description": "Returns an application type name resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application type": { - "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationType_Put", - "description": "Creates the application type name resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application type name resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application type": { - "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationType_Delete", - "description": "Deletes the application type name resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application type": { - "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes": { - "get": { - "tags": [ - "ApplicationType" - ], - "operationId": "ApplicationType_List", - "description": "Returns all application type names in the specified cluster.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application type version resources": { - "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationTypeResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { - "get": { - "tags": [ - "Version" - ], - "operationId": "Version_Get", - "description": "Returns an application type version resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application type version": { - "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/VersionResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Version" - ], - "operationId": "Version_Put", - "description": "Provisions an application type version resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application type version resource.", - "required": true, - "schema": { - "$ref": "#/definitions/VersionResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application type version": { - "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/VersionResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Version" - ], - "operationId": "Version_Delete", - "description": "Unprovisions an application type version resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/version" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application type version": { - "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { - "get": { - "tags": [ - "Version" - ], - "operationId": "Version_List", - "description": "Returns all versions for the specified application type.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationTypeName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application type version resources": { - "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/VersionResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Application_Get", - "description": "Returns an application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get an application": { - "$ref": "./examples/ApplicationGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Application" - ], - "operationId": "Application_Put", - "description": "Creates or updates an application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put an application with mininum parameters": { - "$ref": "./examples/ApplicationPutOperation_example_min.json" - }, - "Put an application with maximum parameters": { - "$ref": "./examples/ApplicationPutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ApplicationResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "tags": [ - "Application" - ], - "operationId": "Application_Patch", - "description": "Updates an application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The application resource for patch operations.", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationResourceUpdate" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Patch an application": { - "$ref": "./examples/ApplicationPatchOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ApplicationResourceUpdate" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Application" - ], - "operationId": "Application_Delete", - "description": "Deletes an application resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete an application": { - "$ref": "./examples/ApplicationDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "Application_List", - "description": "Returns all application resources in the specified cluster.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of application resources": { - "$ref": "./examples/ApplicationListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ApplicationResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { - "get": { - "tags": [ - "Service" - ], - "operationId": "Service_Get", - "description": "Returns a service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a service": { - "$ref": "./examples/ServiceGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Service" - ], - "operationId": "Service_Put", - "description": "Creates or updates a service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The service resource.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put a service with mininum parameters": { - "$ref": "./examples/ServicePutOperation_example_min.json" - }, - "Put a service with maximum parameters": { - "$ref": "./examples/ServicePutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServiceResource" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "tags": [ - "Service" - ], - "operationId": "Service_Patch", - "description": "Updates a service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "parameters", - "in": "body", - "description": "The service resource for patch operations.", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResourceUpdate" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Patch a service": { - "$ref": "./examples/ServicePatchOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServiceResourceUpdate" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Service" - ], - "operationId": "Service_Delete", - "description": "Deletes a service resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/serviceName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Delete a service": { - "$ref": "./examples/ServiceDeleteOperation_example.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "202": { - "description": "The request was accepted and the operation will complete asynchronously." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services": { - "get": { - "tags": [ - "Service" - ], - "operationId": "Service_List", - "description": "Returns all service resources in the specified application.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/applicationName" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "x-ms-examples": { - "Get a list of service resources": { - "$ref": "./examples/ServiceListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ServiceResourceList" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - } - }, - "definitions": { - "ApplicationHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean", - "description": "Indicates whether warnings are treated with the same severity as errors.", - "default": false - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n", - "default": 0 - }, - "DefaultServiceTypeHealthPolicy": { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - }, - "ServiceTypeHealthPolicyMap": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMap" - } - } - }, - "ApplicationMetricDescription": { - "type": "object", - "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n", - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric." - }, - "MaximumCapacity": { - "type": "integer", - "format": "int64", - "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" - }, - "ReservationCapacity": { - "type": "integer", - "format": "int64", - "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" - }, - "TotalApplicationCapacity": { - "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n", - "type": "integer", - "format": "int64" - } - } - }, - "ApplicationMetricDescriptionList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationMetricDescription" - }, - "description": "List of application capacity metric description." - }, - "ApplicationParameter": { - "type": "object", - "description": "Describes an application parameter override to be applied when creating or upgrading an application.", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The name of the parameter." - }, - "Value": { - "type": "string", - "description": "The value of the parameter." - } - } - }, - "ApplicationParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application parameters with overridden values from their default values specified in the application manifest." - }, - "ApplicationTypeName": { - "type": "string", - "description": "The application type name as defined in the application manifest." - }, - "ApplicationTypeParameterList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationParameter" - }, - "description": "List of application type parameters that can be overridden when creating or updating the application." - }, - "ApplicationTypeVersion": { - "type": "string", - "description": "The version of the application type as defined in the application manifest." - }, - "ForceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", - "default": false - }, - "HealthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H10M0S" - }, - "HealthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "PT0H2M0S" - }, - "HealthCheckWaitDuration": { - "type": "string", - "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "0" - }, - "ServiceTypeHealthPolicy": { - "type": "object", - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", - "properties": { - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.\n", - "default": 0 - }, - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.\n", - "default": 0 - }, - "MaxPercentUnhealthyServices": { - "type": "integer", - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.\n", - "default": 0 - } - } - }, - "ServiceTypeHealthPolicyMap": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" - }, - "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" - }, - "ServiceTypeHealthPolicyMapItem": { - "type": "object", - "description": "Defines an item in ServiceTypeHealthPolicyMap.\n", - "required": [ - "Key", - "Value" - ], - "properties": { - "Key": { - "type": "string", - "description": "The key of the service type health policy map item. This is the name of the service type." - }, - "Value": { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - } - } - }, - "UpgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", - "default": "P10675199DT02H48M05.4775807S" - }, - "UpgradeReplicaSetCheckTimeout": { - "type": "integer", - "format": "int64", - "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", - "default": 42949672925 - }, - "ServiceKind": { - "type": "string", - "description": "The kind of service (Stateless or Stateful). Following are the possible values.\n\n- Invalid - Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n- Stateless - Does not use Service Fabric to make its state highly available or reliable. The value is 1.\n- Stateful - Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.\n", - "enum": [ - "Invalid", - "Stateless", - "Stateful" - ] - }, - "ServiceName": { - "type": "string", - "description": "The full name of the service with 'fabric:' URI scheme." - }, - "CorrelationSchemeList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "ServiceCorrelationDescription": { - "type": "object", - "description": "Creates a particular correlation between services.", - "required": [ - "Scheme", - "ServiceName" - ], - "properties": { - "Scheme": { - "$ref": "#/definitions/ServiceCorrelationScheme" - }, - "ServiceName": { - "$ref": "#/definitions/ServiceName" - } - } - }, - "ServiceCorrelationScheme": { - "type": "string", - "description": "The service correlation scheme. Possible values are following.\n\n - Invalid - An invalid correlation scheme. Cannot be used. The value is zero.\n - Affinity - Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1.\n - AlignedAffinity - Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2.\n - NonAlignedAffinity - Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3.\n", - "enum": [ - "Invalid", - "Affinity", - "AlignedAffinity", - "NonAlignedAffinity" - ] - }, - "ServiceLoadMetricsList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceLoadMetricDescription" - }, - "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." - }, - "ServiceLoadMetricDescription": { - "type": "object", - "description": "Specifies a metric to load balance a service during runtime.", - "required": [ - "Name" - ], - "properties": { - "Name": { - "type": "string", - "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." - }, - "Weight": { - "$ref": "#/definitions/ServiceLoadMetricWeight" - }, - "PrimaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." - }, - "SecondaryDefaultLoad": { - "type": "integer", - "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." - }, - "DefaultLoad": { - "type": "integer", - "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." - } - } - }, - "ServiceLoadMetricWeight": { - "type": "string", - "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. Possible values are following.\n\n - Zero - Disables resource balancing for this metric. This value is zero.\n - Low - Specifies the metric weight of the service load as Low. The value is 1.\n - Medium - Specifies the metric weight of the service load as Medium. The value is 2.\n - High - Specifies the metric weight of the service load as High. The value is 3.\n", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ] - }, - "ServicePlacementPoliciesList": { - "type": "array", - "items": { - "$ref": "#/definitions/ServicePlacementPolicyDescription" - }, - "description": "A list that describes the correlation of the service with other services." - }, - "ServicePlacementPolicyDescription": { - "type": "object", - "discriminator": "Type", - "description": "Describes the policy to be used for placement of a Service Fabric service.", - "required": [ - "Type" - ], - "properties": { - "Type": { - "$ref": "#/definitions/ServicePlacementPolicyType" - } - } - }, - "ServicePlacementPolicyType": { - "type": "string", - "description": "The type of placement policy for a service fabric service. Following are the possible values.\n\n - Invalid - Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n - InvalidDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1.\n - RequiredDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2.\n - PreferredPrimaryDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3.\n - RequiredDomainDistribution - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4.\n - NonPartiallyPlaceService - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5.\n", - "enum": [ - "Invalid", - "InvalidDomain", - "RequiredDomain", - "PreferredPrimaryDomain", - "RequiredDomainDistribution", - "NonPartiallyPlaceService" - ] - }, - "PartitionScheme": { - "type": "string", - "description": "Enumerates the ways that a service can be partitioned. Possible values are:\n\n- Invalid - Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n- Singleton - Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.\n- UniformInt64Range - Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.\n- Named - Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3\n", - "enum": [ - "Invalid", - "Singleton", - "UniformInt64Range", - "Named" - ] - }, - "PartitionSchemeDescription": { - "type": "object", - "discriminator": "PartitionScheme", - "description": "Describes how the service is partitioned.", - "required": [ - "PartitionScheme" - ], - "properties": { - "PartitionScheme": { - "$ref": "#/definitions/PartitionScheme" - } - } - }, - "NamedPartitionSchemeDescription": { - "description": "Describes the named partition scheme of the service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "NamedPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Named", - "required": [ - "Count", - "Names" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "Names": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." - } - } - }, - "SingletonPartitionSchemeDescription": { - "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "SingletonPartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "Singleton" - }, - "UniformInt64RangePartitionSchemeDescription": { - "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", - "allOf": [ - { - "$ref": "#/definitions/PartitionSchemeDescription" - }, - { - "type": "object", - "description": "UniformInt64RangePartitionSchemeDescription" - } - ], - "x-ms-discriminator-value": "UniformInt64Range", - "required": [ - "Count", - "LowKey", - "HighKey" - ], - "properties": { - "Count": { - "type": "integer", - "description": "The number of partitions." - }, - "LowKey": { - "type": "string", - "description": "String indicating the lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" - }, - "HighKey": { - "type": "string", - "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" - } - } - }, - "MoveCost": { - "type": "string", - "description": "Specifies the move cost for the service. Possible values are the following.\n\n - Zero - Zero move cost. This value is zero.\n - Low - Specifies the move cost of the service as Low. The value is 1.\n - Medium - Specifies the move cost of the service as Medium. The value is 2.\n - High - Specifies the move cost of the service as High. The value is 3.\n", - "enum": [ - "Zero", - "Low", - "Medium", - "High" - ] - }, - "AddOnFeatures": { - "type": "string", - "description": "Available cluster add-on features", - "enum": [ - "RepairManager", - "DnsService", - "BackupRestoreService" - ] - }, - "ApplicationTypeResource": { - "description": "The application type name resource", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationTypeProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationTypeResourceList": { - "description": "The list of application type names.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationTypeResource" - } - } - } - }, - "ApplicationTypeProperties": { - "description": "The application type name properties", - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response." - } - } - }, - "VersionResource": { - "description": "A version resource for the specified application type name.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VersionProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "VersionResourceList": { - "description": "The list of version resources for the specified application type name.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VersionResource" - } - } - } - }, - "VersionProperties": { - "description": "The properties of the version resource.", - "required": [ - "appPackageUrl" - ], - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "appPackageUrl": { - "type": "string", - "description": "The URL to the application package" - }, - "defaultParameterList": { - "readOnly": true, - "$ref": "#/definitions/ApplicationTypeParameterList" - } - } - }, - "ApplicationResource": { - "description": "The application resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationResourceList": { - "description": "The list of application resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationResource" - } - } - } - }, - "ApplicationProperties": { - "description": "The application resource properties.", - "allOf": [ - { - "$ref": "#/definitions/ApplicationUpdateProperties" - } - ], - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "typeName": { - "$ref": "#/definitions/ApplicationTypeName" - } - } - }, - "ApplicationResourceUpdate": { - "description": "The application resource for patch operations.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationUpdateProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ApplicationUpdateProperties": { - "description": "The application resource properties for patch operations.", - "properties": { - "typeVersion": { - "$ref": "#/definitions/ApplicationTypeVersion" - }, - "parameters": { - "$ref": "#/definitions/ApplicationParameterList" - }, - "upgradePolicy": { - "$ref": "#/definitions/ApplicationUpgradePolicy" - }, - "minimumNodes": { - "type": "integer", - "format": "int64", - "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", - "minimum": 0 - }, - "maximumNodes": { - "type": "integer", - "format": "int64", - "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", - "minimum": 0, - "default": 0 - }, - "removeApplicationCapacity": { - "type": "boolean", - "description": "The version of the application type" - }, - "metrics": { - "$ref": "#/definitions/ApplicationMetricDescriptionList" - } - } - }, - "ApplicationUpgradePolicy": { - "description": "Describes the policy for a monitored application upgrade.", - "properties": { - "upgradeReplicaSetCheckTimeout": { - "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout" - }, - "forceRestart": { - "$ref": "#/definitions/ForceRestart" - }, - "rollingUpgradeMonitoringPolicy": { - "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" - }, - "applicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - } - }, - "ServiceResource": { - "description": "The service resource.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ServiceResourceList": { - "description": "The list of service resources.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResource" - } - } - } - }, - "ServiceProperties": { - "description": "The service resource properties.", - "allOf": [ - { - "$ref": "#/definitions/ServicePropertiesBase" - } - ], - "required": [ - "serviceKind" - ], - "discriminator": "serviceKind", - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The current deployment or provisioning state, which only appears in the response" - }, - "serviceKind": { - "$ref": "#/definitions/ServiceKind" - }, - "serviceTypeName": { - "type": "string", - "description": "The name of the service type" - }, - "partitionDescription": { - "$ref": "#/definitions/PartitionSchemeDescription" - } - } - }, - "ServicePropertiesBase": { - "description": "The common service resource properties.", - "properties": { - "placementConstraints": { - "type": "string", - "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." - }, - "correlationScheme": { - "$ref": "#/definitions/CorrelationSchemeList" - }, - "serviceLoadMetrics": { - "$ref": "#/definitions/ServiceLoadMetricsList" - }, - "servicePlacementPolicies": { - "$ref": "#/definitions/ServicePlacementPoliciesList" - }, - "defaultMoveCost": { - "$ref": "#/definitions/MoveCost" - } - } - }, - "ServiceResourceUpdate": { - "description": "The service resource for patch operations.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceUpdateProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ] - }, - "ServiceUpdateProperties": { - "description": "The service resource properties for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServicePropertiesBase" - } - ], - "required": [ - "serviceKind" - ], - "discriminator": "serviceKind", - "properties": { - "serviceKind": { - "$ref": "#/definitions/ServiceKind" - } - } - }, - "StatelessServiceProperties": { - "description": "The properties of a stateless service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "instanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "StatelessServiceUpdateProperties": { - "description": "The properties of a stateless service resource for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateProperties" - } - ], - "x-ms-discriminator-value": "Stateless", - "properties": { - "instanceCount": { - "type": "integer", - "minimum": -1, - "description": "The instance count." - } - } - }, - "StatefulServiceProperties": { - "description": "The properties of a stateful service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceProperties" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "hasPersistedState": { - "type": "boolean", - "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." - }, - "targetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "minReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "replicaRestartWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "quorumLossWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "standByReplicaKeepDuration": { - "type": "string", - "format": "date-time", - "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." - } - } - }, - "StatefulServiceUpdateProperties": { - "description": "The properties of a stateful service resource for patch operations.", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateProperties" - } - ], - "x-ms-discriminator-value": "Stateful", - "properties": { - "targetReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The target replica set size as a number." - }, - "minReplicaSetSize": { - "type": "integer", - "minimum": 1, - "description": "The minimum replica set size as a number." - }, - "replicaRestartWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "quorumLossWaitDuration": { - "type": "string", - "format": "date-time", - "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." - }, - "standByReplicaKeepDuration": { - "type": "string", - "format": "date-time", - "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." - } - } - }, - "AvailableOperationDisplay": { - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider." - }, - "resource": { - "type": "string", - "description": "The resource on which the operation is performed" - }, - "operation": { - "type": "string", - "description": "The operation that can be performed." - }, - "description": { - "type": "string", - "description": "Operation description" - } - }, - "description": "Operation supported by Service Fabric resource provider" - }, - "AzureActiveDirectory": { - "properties": { - "tenantId": { - "type": "string", - "description": "Azure active directory tenant id." - }, - "clusterApplication": { - "type": "string", - "description": "Azure active directory cluster application id." - }, - "clientApplication": { - "type": "string", - "description": "Azure active directory client application id." - } - }, - "description": "The settings to enable AAD authentication on the cluster." - }, - "CertificateDescription": { - "required": [ - "thumbprint" - ], - "properties": { - "thumbprint": { - "type": "string", - "description": "Thumbprint of the primary certificate." - }, - "thumbprintSecondary": { - "type": "string", - "description": "Thumbprint of the secondary certificate." - }, - "x509StoreName": { - "type": "string", - "description": "The local certificate store location.", - "enum": [ - "AddressBook", - "AuthRoot", - "CertificateAuthority", - "Disallowed", - "My", - "Root", - "TrustedPeople", - "TrustedPublisher" - ] - } - }, - "description": "Describes the certificate details." - }, - "ClientCertificateCommonName": { - "required": [ - "certificateCommonName", - "isAdmin", - "certificateIssuerThumbprint" - ], - "properties": { - "isAdmin": { - "type": "boolean", - "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." - }, - "certificateCommonName": { - "type": "string", - "description": "The common name of the client certificate." - }, - "certificateIssuerThumbprint": { - "type": "string", - "description": "The issuer thumbprint of the client certificate." - } - }, - "description": "Describes the client certificate details using common name." - }, - "ClientCertificateThumbprint": { - "required": [ - "certificateThumbprint", - "isAdmin" - ], - "properties": { - "isAdmin": { - "type": "boolean", - "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." - }, - "certificateThumbprint": { - "type": "string", - "description": "The thumbprint of the client certificate." - } - }, - "description": "Describes the client certificate details using thumbprint." - }, - "Cluster": { - "type": "object", - "description": "The cluster resource\n", - "allOf": [ - { - "description": "The cluster resource properties" - }, - { - "$ref": "#/definitions/Resource" - }, - { - "type": "object", - "properties": { - "properties": { - "description": "The cluster resource properties", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterProperties" - } - } - } - ] - }, - "ClusterCodeVersionsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClusterCodeVersionsResult" - } - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "The list results of the ServiceFabric runtime versions." - }, - "ClusterCodeVersionsResult": { - "properties": { - "id": { - "type": "string", - "description": "The identification of the result" - }, - "name": { - "type": "string", - "description": "The name of the result" - }, - "type": { - "type": "string", - "description": "The result resource type" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterVersionDetails" - } - }, - "description": "The result of the ServiceFabric runtime versions" - }, - "ClusterEnvironment": { - "type": "string", - "description": "Cluster operating system, the default will be Windows", - "enum": [ - "Windows", - "Linux" - ] - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Cluster list results" - }, - "ClusterProperties": { - "required": [ - "managementEndpoint", - "nodeTypes" - ], - "properties": { - "availableClusterVersions": { - "type": "array", - "description": "The Service Fabric runtime versions available for this cluster.", - "items": { - "$ref": "#/definitions/ClusterVersionDetails" - } - }, - "clusterId": { - "type": "string", - "description": "A service generated unique identifier for the cluster resource.", - "readOnly": true - }, - "clusterState": { - "$ref": "#/definitions/ClusterState" - }, - "clusterEndpoint": { - "type": "string", - "description": "The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.", - "readOnly": true - }, - "clusterCodeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." - }, - "certificate": { - "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.", - "$ref": "#/definitions/CertificateDescription" - }, - "reliabilityLevel": { - "$ref": "#/definitions/ReliabilityLevel" - }, - "upgradeMode": { - "$ref": "#/definitions/UpgradeMode" - }, - "clientCertificateThumbprints": { - "type": "array", - "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster.", - "items": { - "$ref": "#/definitions/ClientCertificateThumbprint" - } - }, - "clientCertificateCommonNames": { - "type": "array", - "description": "The list of client certificates referenced by common name that are allowed to manage the cluster.", - "items": { - "$ref": "#/definitions/ClientCertificateCommonName" - } - }, - "fabricSettings": { - "type": "array", - "description": "The list of custom fabric settings to configure the cluster.", - "items": { - "$ref": "#/definitions/SettingsSectionDescription" - } - }, - "reverseProxyCertificate": { - "description": "The server certificate used by reverse proxy.", - "$ref": "#/definitions/CertificateDescription" - }, - "managementEndpoint": { - "type": "string", - "description": "The http management endpoint of the cluster." - }, - "nodeTypes": { - "type": "array", - "description": "The list of node types in the cluster.", - "items": { - "$ref": "#/definitions/NodeTypeDescription" - } - }, - "azureActiveDirectory": { - "description": "The AAD authentication settings of the cluster.", - "$ref": "#/definitions/AzureActiveDirectory" - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the cluster resource.", - "readOnly": true, - "enum": [ - "Updating", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "vmImage": { - "type": "string", - "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." - }, - "diagnosticsStorageAccountConfig": { - "description": "The storage account information for storing Service Fabric diagnostic logs.", - "$ref": "#/definitions/DiagnosticsStorageAccountConfig" - }, - "upgradeDescription": { - "description": "The policy to use when upgrading the cluster.", - "$ref": "#/definitions/ClusterUpgradePolicy" - }, - "addOnFeatures": { - "type": "array", - "description": "The list of add-on features to enable in the cluster.", - "items": { - "$ref": "#/definitions/AddOnFeatures" - } - } - }, - "description": "Describes the cluster resource properties." - }, - "ClusterPropertiesUpdateParameters": { - "properties": { - "reliabilityLevel": { - "type": "string", - "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).", - "enum": [ - "Bronze", - "Silver", - "Gold" - ] - }, - "upgradeMode": { - "type": "string", - "description": "The upgrade mode of the cluster. This indicates if the cluster should be automatically upgraded when new Service Fabric runtime version is available.", - "enum": [ - "Automatic", - "Manual" - ] - }, - "clusterCodeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." - }, - "certificate": { - "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.", - "$ref": "#/definitions/CertificateDescription" - }, - "clientCertificateThumbprints": { - "type": "array", - "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/ClientCertificateThumbprint" - } - }, - "clientCertificateCommonNames": { - "type": "array", - "description": "The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/ClientCertificateCommonName" - } - }, - "fabricSettings": { - "type": "array", - "description": "The list of custom fabric settings to configure the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/SettingsSectionDescription" - } - }, - "reverseProxyCertificate": { - "description": "The server certificate used by reverse proxy.", - "$ref": "#/definitions/CertificateDescription" - }, - "nodeTypes": { - "type": "array", - "description": "The list of node types in the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/NodeTypeDescription" - } - }, - "upgradeDescription": { - "description": "The policy to use when upgrading the cluster.", - "$ref": "#/definitions/ClusterUpgradePolicy" - }, - "addOnFeatures": { - "type": "array", - "description": "The list of add-on features to enable in the cluster.", - "items": { - "$ref": "#/definitions/AddOnFeatures" - } - } - }, - "description": "Describes the cluster resource properties that can be updated during PATCH operation." - }, - "ClusterUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterPropertiesUpdateParameters" - }, - "tags": { - "type": "object", - "description": "Cluster update parameters", - "additionalProperties": { - "type": "string" - } - } - }, - "description": "Cluster update request" - }, - "ClusterUpgradeDeltaHealthPolicy": { - "required": [ - "maxPercentDeltaUnhealthyApplications", - "maxPercentDeltaUnhealthyNodes", - "maxPercentUpgradeDomainDeltaUnhealthyNodes" - ], - "properties": { - "maxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.", - "minimum": 0, - "maximum": 100 - }, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ", - "minimum": 0, - "maximum": 100 - }, - "maxPercentDeltaUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.", - "minimum": 0, - "maximum": 100 - } - }, - "description": "Describes the delta health policies for the cluster upgrade." - }, - "ClusterUpgradePolicy": { - "required": [ - "healthCheckRetryTimeout", - "healthCheckStableDuration", - "healthCheckWaitDuration", - "healthPolicy", - "upgradeDomainTimeout", - "upgradeReplicaSetCheckTimeout", - "upgradeTimeout" - ], - "properties": { - "forceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "upgradeReplicaSetCheckTimeout": { - "type": "string", - "description": "The maximum amount of time to block processing of an upgrade domain and revent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckWaitDuration": { - "type": "string", - "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "upgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "upgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthPolicy": { - "description": "The cluster health policy used when upgrading the cluster.", - "$ref": "#/definitions/ClusterHealthPolicy" - }, - "deltaHealthPolicy": { - "description": "The delta health policy used when upgrading the cluster.", - "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" - } - }, - "description": "Describes the policy used when upgrading the cluster." - }, - "ClusterVersionDetails": { - "properties": { - "codeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster." - }, - "supportExpiryUtc": { - "type": "string", - "description": "The date of expiry of support of the version." - }, - "environment": { - "description": "Indicates if this version is for Windows or Linux operating system.", - "$ref": "#/definitions/ClusterEnvironment" - } - }, - "description": "The detail of the Service Fabric runtime version result" - }, - "DiagnosticsStorageAccountConfig": { - "required": [ - "blobEndpoint", - "protectedAccountKeyName", - "queueEndpoint", - "storageAccountName", - "tableEndpoint" - ], - "properties": { - "storageAccountName": { - "type": "string", - "description": "The Azure storage account name." - }, - "protectedAccountKeyName": { - "type": "string", - "description": "The protected diagnostics storage key name." - }, - "blobEndpoint": { - "type": "string", - "description": "The blob endpoint of the azure storage account." - }, - "queueEndpoint": { - "type": "string", - "description": "The queue endpoint of the azure storage account." - }, - "tableEndpoint": { - "type": "string", - "description": "The table endpoint of the azure storage account." - } - }, - "description": "The storage account information for storing Service Fabric diagnostic logs." - }, - "EndpointRangeDescription": { - "required": [ - "endPort", - "startPort" - ], - "properties": { - "startPort": { - "type": "integer", - "description": "Starting port of a range of ports" - }, - "endPort": { - "type": "integer", - "description": "End port of a range of ports" - } - }, - "description": "Port range details" - }, - "ErrorModel": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "The error details." - }, - "NodeTypeDescription": { - "required": [ - "clientConnectionEndpointPort", - "httpGatewayEndpointPort", - "isPrimary", - "name", - "vmInstanceCount" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the node type." - }, - "placementProperties": { - "type": "object", - "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", - "additionalProperties": { - "type": "string", - "description": "Placement tag value" - } - }, - "capacities": { - "type": "object", - "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", - "additionalProperties": { - "type": "string", - "description": "Capacity tag value" - } - }, - "clientConnectionEndpointPort": { - "type": "integer", - "description": "The TCP cluster management endpoint port." - }, - "httpGatewayEndpointPort": { - "type": "integer", - "description": "The HTTP cluster management endpoint port." - }, - "durabilityLevel": { - "$ref": "#/definitions/DurabilityLevel" - }, - "applicationPorts": { - "description": "The range of ports from which cluster assigned port to Service Fabric applications.", - "$ref": "#/definitions/EndpointRangeDescription" - }, - "ephemeralPorts": { - "description": "The range of empheral ports that nodes in this node type should be configured with.", - "$ref": "#/definitions/EndpointRangeDescription" - }, - "isPrimary": { - "type": "boolean", - "description": "The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters." - }, - "vmInstanceCount": { - "type": "integer", - "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", - "minimum": 1, - "maximum": 2147483647 - }, - "reverseProxyEndpointPort": { - "type": "integer", - "description": "The endpoint used by reverse proxy." - } - }, - "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." - }, - "OperationListResult": { - "properties": { - "value": { - "type": "array", - "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", - "items": { - "$ref": "#/definitions/OperationResult" - } - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - }, - "description": "Describes the result of the request to list Service Fabric operations." - }, - "OperationResult": { - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "description": "The object that represents the operation.", - "$ref": "#/definitions/AvailableOperationDisplay" - }, - "origin": { - "type": "string", - "description": "Origin result" - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Available operation list result" - }, - "ProxyResource": { - "required": [ - "location" - ], - "properties": { - "id": { - "type": "string", - "description": "Azure resource ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Azure resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Azure resource type.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Resource location." - } - }, - "description": "The resource model definition for proxy-only resource.", - "x-ms-azure-resource": true - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "type": "string", - "description": "Azure resource ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Azure resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Azure resource type.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "type": "object", - "description": "Resource tags.", - "additionalProperties": { - "type": "string" - } - } - }, - "description": "The resource model definition.", - "x-ms-azure-resource": true - }, - "RollingUpgradeMonitoringPolicy": { - "description": "The policy used for monitoring the application upgrade", - "properties": { - "healthCheckWaitDuration": { - "$ref": "#/definitions/HealthCheckWaitDuration" - }, - "healthCheckStableDuration": { - "$ref": "#/definitions/HealthCheckStableDuration" - }, - "healthCheckRetryTimeout": { - "$ref": "#/definitions/HealthCheckRetryTimeout" - }, - "upgradeTimeout": { - "$ref": "#/definitions/UpgradeTimeout" - }, - "upgradeDomainTimeout": { - "$ref": "#/definitions/UpgradeDomainTimeout" - } - } - }, - "ServiceTypeDeltaHealthPolicy": { - "type": "object", - "description": "Service health policy\n", - "properties": { - "maxPercentDeltaUnhealthyServices": { - "description": "Maximum percentage of unhealthy services in cluster", - "type": "integer", - "maximum": 100, - "minimum": 0 - } - } - }, - "SettingsParameterDescription": { - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "The parameter name of fabric setting." - }, - "value": { - "type": "string", - "description": "The parameter value of fabric setting." - } - }, - "description": "Describes a parameter in fabric settings of the cluster." - }, - "SettingsSectionDescription": { - "required": [ - "name", - "parameters" - ], - "properties": { - "name": { - "type": "string", - "description": "The section name of the fabric settings." - }, - "parameters": { - "type": "array", - "description": "The collection of parameters in the section.", - "items": { - "$ref": "#/definitions/SettingsParameterDescription" - } - } - }, - "description": "Describes a section in the fabric settings of the cluster." - }, - "ClusterHealthPolicy": { - "properties": { - "maxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. ", - "minimum": 0, - "maximum": 100 - }, - "maxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. ", - "minimum": 0, - "maximum": 100 - } - }, - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." - }, - "ClusterState": { - "type": "string", - "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n", - "enum": [ - "WaitingForNodes", - "Deploying", - "BaselineUpgrade", - "UpdatingUserConfiguration", - "UpdatingUserCertificate", - "UpdatingInfrastructure", - "EnforcingClusterVersion", - "UpgradeServiceUnreachable", - "AutoScale", - "Ready" - ] - }, - "DurabilityLevel": { - "type": "string", - "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 30 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n", - "enum": [ - "Bronze", - "Silver", - "Gold" - ] - }, - "ReliabilityLevel": { - "type": "string", - "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", - "enum": [ - "None", - "Bronze", - "Silver", - "Gold", - "Platinum" - ] - }, - "UpgradeMode": { - "type": "string", - "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n", - "enum": [ - "Automatic", - "Manual" - ] - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "The version of the API.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "applicationName": { - "name": "applicationName", - "in": "path", - "description": "The name of the application resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "applicationTypeName": { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type name resource", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "clusterNameParameter": { - "name": "clusterName", - "in": "path", - "description": "The name of the cluster resource", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "clusterVersion": { - "name": "clusterVersion", - "in": "path", - "description": "The cluster code version", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "environment": { - "name": "environment", - "in": "path", - "description": "Cluster operating system, the default means all", - "required": true, - "type": "string", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-parameter-location": "method" - }, - "locationForClusterCodeVersions": { - "name": "location", - "in": "path", - "description": "The location for the cluster code versions, this is different from cluster location", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "serviceName": { - "name": "serviceName", - "in": "path", - "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The customer subscription identifier", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "version": { - "name": "version", - "in": "path", - "description": "The application type version.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2017-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}": { + "put": { + "operationId": "Clusters_Create", + "summary": "Create a ServiceFabric cluster", + "description": "Create cluster resource\n", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "x-ms-parameter-location": "method" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "Put a cluster with min parameter": { + "$ref": "./examples/ClusterPutOperation_example_min.json" + }, + "Put a cluster with max parameter": { + "$ref": "./examples/ClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "OK - Put cluster successfully", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted - Put request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Clusters_Delete", + "summary": "Delete cluster resource", + "description": "Delete cluster resource\n", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ClusterDeleteOperation_example.json" + } + }, + "responses": { + "200": { + "description": "OK - cluster deleted successfully" + }, + "204": { + "description": "NoContent - cluster does not exist" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Clusters_Get", + "summary": "Get cluster resource", + "description": "Get cluster resource\n", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "OK - Get cluster successfully", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "operationId": "Clusters_Update", + "summary": "Update cluster configuration", + "description": "Update cluster configuration\n", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters which contains the property value and property name which used to update the cluster configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch a cluster": { + "$ref": "./examples/ClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "OK - Cluster updated successfully", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted - Update request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_ListByResourceGroup", + "summary": "List cluster resource by resource group", + "description": "List cluster resource by resource group\n", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "OK - Get cluster successfully", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_List", + "summary": "List cluster resource", + "description": "List cluster resource\n", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List clusters": { + "$ref": "./examples/ClusterListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "OK - Get cluster successfully", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_Get", + "summary": "Get cluster code versions", + "description": "Get cluster code versions by location\n", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "examples/ClusterVersionsGet_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "OK - Get cluster code versions successfully", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_GetByEnvironment", + "summary": "Get cluster code versions by environment", + "description": "Get cluster code versions by environment\n", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "examples/ClusterVersionsGetByEnvironment_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "OK - Get cluster code versions successfully", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_List", + "summary": "List cluster code versions by location", + "description": "List cluster code versions by location\n", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "examples/ClusterVersionsList_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "OK - List cluster code versions successfully", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_ListByEnvironment", + "summary": "List cluster code versions by environment", + "description": "List cluster code versions by environment\n", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "examples/ClusterVersionsListByEnvironment.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "OK - List cluster code versions successfully", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available ServiceFabric Resource Manager REST API operations.", + "description": "", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the ServiceFabric resouce provider api", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationType_Get", + "description": "Returns an application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationType_Put", + "description": "Creates the application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationType_Delete", + "description": "Deletes the application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationType_List", + "description": "Returns all application type names in the specified cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "Version" + ], + "operationId": "Version_Get", + "description": "Returns an application type version resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/VersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Version" + ], + "operationId": "Version_Put", + "description": "Provisions an application type version resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/VersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Version" + ], + "operationId": "Version_Delete", + "description": "Unprovisions an application type version resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "Version" + ], + "operationId": "Version_List", + "description": "Returns all versions for the specified application type.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/VersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_Get", + "description": "Returns an application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Application_Put", + "description": "Creates or updates an application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with mininum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Application_Patch", + "description": "Updates an application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Application_Delete", + "description": "Deletes an application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_List", + "description": "Returns all application resources in the specified cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Service_Get", + "description": "Returns a service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Service_Put", + "description": "Creates or updates a service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with mininum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Service" + ], + "operationId": "Service_Patch", + "description": "Updates a service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource for patch operations.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResourceUpdate" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Service_Delete", + "description": "Deletes a service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Service_List", + "description": "Returns all service resources in the specified application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n", + "default": 0 + }, + "DefaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + }, + "ServiceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap" + } + } + }, + "ApplicationMetricDescription": { + "type": "object", + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.\n", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "MaximumCapacity": { + "type": "integer", + "format": "int64", + "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\n" + }, + "ReservationCapacity": { + "type": "integer", + "format": "int64", + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.\n" + }, + "TotalApplicationCapacity": { + "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.\n", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ApplicationParameter": { + "type": "object", + "description": "Describes an application parameter override to be applied when creating or upgrading an application.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The name of the parameter." + }, + "Value": { + "type": "string", + "description": "The value of the parameter." + } + } + }, + "ApplicationParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H10M0S" + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "0" + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.\n", + "default": 0 + }, + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.\n", + "default": 0 + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.\n", + "default": 0 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" + }, + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n" + }, + "ServiceTypeHealthPolicyMapItem": { + "type": "object", + "description": "Defines an item in ServiceTypeHealthPolicyMap.\n", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the service type health policy map item. This is the name of the service type." + }, + "Value": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", + "default": 42949672925 + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful). Following are the possible values.\n\n- Invalid - Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n- Stateless - Does not use Service Fabric to make its state highly available or reliable. The value is 1.\n- Stateful - Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.\n", + "enum": [ + "Invalid", + "Stateless", + "Stateful" + ] + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServiceCorrelationDescription": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme" + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName" + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme. Possible values are following.\n\n - Invalid - An invalid correlation scheme. Cannot be used. The value is zero.\n - Affinity - Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1.\n - AlignedAffinity - Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2.\n - NonAlignedAffinity - Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3.\n", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ] + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServiceLoadMetricDescription": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight" + }, + "PrimaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "SecondaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "DefaultLoad": { + "type": "integer", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. Possible values are following.\n\n - Zero - Disables resource balancing for this metric. This value is zero.\n - Low - Specifies the metric weight of the service load as Low. The value is 1.\n - Medium - Specifies the metric weight of the service load as Medium. The value is 2.\n - High - Specifies the metric weight of the service load as High. The value is 3.\n", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType" + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.\n\n - Invalid - Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n - InvalidDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1.\n - RequiredDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2.\n - PreferredPrimaryDomain - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3.\n - RequiredDomainDistribution - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4.\n - NonPartiallyPlaceService - Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5.\n", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ] + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned. Possible values are:\n\n- Invalid - Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.\n- Singleton - Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.\n- UniformInt64Range - Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.\n- Named - Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3\n", + "enum": [ + "Invalid", + "Singleton", + "UniformInt64Range", + "Named" + ] + }, + "PartitionSchemeDescription": { + "type": "object", + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme" + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "NamedPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "Count", + "Names" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "Names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." + } + } + }, + "SingletonPartitionSchemeDescription": { + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "SingletonPartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "UniformInt64RangePartitionSchemeDescription": { + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "Count", + "LowKey", + "HighKey" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "LowKey": { + "type": "string", + "description": "String indicating the lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service. Possible values are the following.\n\n - Zero - Zero move cost. This value is zero.\n - Low - Specifies the move cost of the service as Low. The value is 1.\n - Medium - Specifies the move cost of the service as Medium. The value is 2.\n - High - Specifies the move cost of the service as High. The value is 3.\n", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ] + }, + "AddOnFeatures": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService" + ] + }, + "ApplicationTypeResource": { + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + } + } + }, + "ApplicationTypeProperties": { + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "VersionResource": { + "description": "A version resource for the specified application type name.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "VersionResourceList": { + "description": "The list of version resources for the specified application type name.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VersionResource" + } + } + } + }, + "VersionProperties": { + "description": "The properties of the version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + }, + "defaultParameterList": { + "readOnly": true, + "$ref": "#/definitions/ApplicationTypeParameterList" + } + } + }, + "ApplicationResource": { + "description": "The application resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + } + } + }, + "ApplicationProperties": { + "description": "The application resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "typeName": { + "$ref": "#/definitions/ApplicationTypeName" + } + } + }, + "ApplicationResourceUpdate": { + "description": "The application resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationUpdateProperties": { + "description": "The application resource properties for patch operations.", + "properties": { + "typeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion" + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList" + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + "minimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", + "minimum": 0 + }, + "maximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", + "minimum": 0, + "default": 0 + }, + "removeApplicationCapacity": { + "type": "boolean", + "description": "The version of the application type" + }, + "metrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList" + } + } + }, + "ApplicationUpgradePolicy": { + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "upgradeReplicaSetCheckTimeout": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout" + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart" + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + }, + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + } + }, + "ServiceResource": { + "description": "The service resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + } + } + }, + "ServiceProperties": { + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServicePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription" + } + } + }, + "ServicePropertiesBase": { + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList" + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList" + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList" + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost" + } + } + }, + "ServiceResourceUpdate": { + "description": "The service resource for patch operations.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceUpdateProperties": { + "description": "The service resource properties for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServicePropertiesBase" + } + ], + "required": [ + "serviceKind" + ], + "discriminator": "serviceKind", + "properties": { + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + } + } + }, + "StatelessServiceProperties": { + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "StatelessServiceUpdateProperties": { + "description": "The properties of a stateless service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "instanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "StatefulServiceProperties": { + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "StatefulServiceUpdateProperties": { + "description": "The properties of a stateful service resource for patch operations.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "targetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "quorumLossWaitDuration": { + "type": "string", + "format": "date-time", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format (hh:mm:ss.s)." + }, + "standByReplicaKeepDuration": { + "type": "string", + "format": "date-time", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s)." + } + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by Service Fabric resource provider" + }, + "AzureActiveDirectory": { + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "required": [ + "thumbprint" + ], + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "type": "string", + "description": "The local certificate store location.", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + } + }, + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "required": [ + "certificateCommonName", + "isAdmin", + "certificateIssuerThumbprint" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "required": [ + "certificateThumbprint", + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using thumbprint." + }, + "Cluster": { + "type": "object", + "description": "The cluster resource\n", + "allOf": [ + { + "description": "The cluster resource properties" + }, + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "The cluster resource properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties" + } + } + } + ] + }, + "ClusterCodeVersionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterCodeVersionsResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "The list results of the ServiceFabric runtime versions." + }, + "ClusterCodeVersionsResult": { + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterVersionDetails" + } + }, + "description": "The result of the ServiceFabric runtime versions" + }, + "ClusterEnvironment": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows", + "Linux" + ] + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Cluster list results" + }, + "ClusterProperties": { + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "properties": { + "availableClusterVersions": { + "type": "array", + "description": "The Service Fabric runtime versions available for this cluster.", + "items": { + "$ref": "#/definitions/ClusterVersionDetails" + } + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "$ref": "#/definitions/ClusterState" + }, + "clusterEndpoint": { + "type": "string", + "description": "The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.", + "readOnly": true + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "certificate": { + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.", + "$ref": "#/definitions/CertificateDescription" + }, + "reliabilityLevel": { + "$ref": "#/definitions/ReliabilityLevel" + }, + "upgradeMode": { + "$ref": "#/definitions/UpgradeMode" + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "reverseProxyCertificate": { + "description": "The server certificate used by reverse proxy.", + "$ref": "#/definitions/CertificateDescription" + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "azureActiveDirectory": { + "description": "The AAD authentication settings of the cluster.", + "$ref": "#/definitions/AzureActiveDirectory" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the cluster resource.", + "readOnly": true, + "enum": [ + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + }, + "diagnosticsStorageAccountConfig": { + "description": "The storage account information for storing Service Fabric diagnostic logs.", + "$ref": "#/definitions/DiagnosticsStorageAccountConfig" + }, + "upgradeDescription": { + "description": "The policy to use when upgrading the cluster.", + "$ref": "#/definitions/ClusterUpgradePolicy" + }, + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + } + }, + "description": "Describes the cluster resource properties." + }, + "ClusterPropertiesUpdateParameters": { + "properties": { + "reliabilityLevel": { + "type": "string", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + "upgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster. This indicates if the cluster should be automatically upgraded when new Service Fabric runtime version is available.", + "enum": [ + "Automatic", + "Manual" + ] + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "certificate": { + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.", + "$ref": "#/definitions/CertificateDescription" + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "reverseProxyCertificate": { + "description": "The server certificate used by reverse proxy.", + "$ref": "#/definitions/CertificateDescription" + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "upgradeDescription": { + "description": "The policy to use when upgrading the cluster.", + "$ref": "#/definitions/ClusterUpgradePolicy" + }, + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + } + }, + "description": "Describes the cluster resource properties that can be updated during PATCH operation." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterPropertiesUpdateParameters" + }, + "tags": { + "type": "object", + "description": "Cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Cluster update request" + }, + "ClusterUpgradeDeltaHealthPolicy": { + "required": [ + "maxPercentDeltaUnhealthyApplications", + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes" + ], + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. ", + "minimum": 0, + "maximum": 100 + }, + "maxPercentDeltaUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades. The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.", + "minimum": 0, + "maximum": 100 + } + }, + "description": "Describes the delta health policies for the cluster upgrade." + }, + "ClusterUpgradePolicy": { + "required": [ + "healthCheckRetryTimeout", + "healthCheckStableDuration", + "healthCheckWaitDuration", + "healthPolicy", + "upgradeDomainTimeout", + "upgradeReplicaSetCheckTimeout", + "upgradeTimeout" + ], + "properties": { + "forceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "The maximum amount of time to block processing of an upgrade domain and revent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthPolicy": { + "description": "The cluster health policy used when upgrading the cluster.", + "$ref": "#/definitions/ClusterHealthPolicy" + }, + "deltaHealthPolicy": { + "description": "The delta health policy used when upgrading the cluster.", + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy" + } + }, + "description": "Describes the policy used when upgrading the cluster." + }, + "ClusterVersionDetails": { + "properties": { + "codeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "environment": { + "description": "Indicates if this version is for Windows or Linux operating system.", + "$ref": "#/definitions/ClusterEnvironment" + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "DiagnosticsStorageAccountConfig": { + "required": [ + "blobEndpoint", + "protectedAccountKeyName", + "queueEndpoint", + "storageAccountName", + "tableEndpoint" + ], + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "EndpointRangeDescription": { + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "ErrorModel": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "NodeTypeDescription": { + "required": [ + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "name", + "vmInstanceCount" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "clientConnectionEndpointPort": { + "type": "integer", + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "type": "integer", + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "$ref": "#/definitions/DurabilityLevel" + }, + "applicationPorts": { + "description": "The range of ports from which cluster assigned port to Service Fabric applications.", + "$ref": "#/definitions/EndpointRangeDescription" + }, + "ephemeralPorts": { + "description": "The range of empheral ports that nodes in this node type should be configured with.", + "$ref": "#/definitions/EndpointRangeDescription" + }, + "isPrimary": { + "type": "boolean", + "description": "The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters." + }, + "vmInstanceCount": { + "type": "integer", + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", + "minimum": 1, + "maximum": 2147483647 + }, + "reverseProxyEndpointPort": { + "type": "integer", + "description": "The endpoint used by reverse proxy." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/AvailableOperationDisplay" + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ProxyResource": { + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location." + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMonitoringPolicy": { + "description": "The policy used for monitoring the application upgrade", + "properties": { + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration" + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration" + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout" + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout" + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout" + } + } + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "description": "Service health policy\n", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "description": "Maximum percentage of unhealthy services in cluster", + "type": "integer", + "maximum": 100, + "minimum": 0 + } + } + }, + "SettingsParameterDescription": { + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "ClusterHealthPolicy": { + "properties": { + "maxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. ", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. ", + "minimum": 0, + "maximum": 100 + } + }, + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "UpdatingUserConfiguration", + "UpdatingUserCertificate", + "UpdatingInfrastructure", + "EnforcingClusterVersion", + "UpgradeServiceUnreachable", + "AutoScale", + "Ready" + ] + }, + "DurabilityLevel": { + "type": "string", + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 30 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + "ReliabilityLevel": { + "type": "string", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + "UpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n", + "enum": [ + "Automatic", + "Manual" + ] + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "Cluster operating system, the default means all", + "required": true, + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-parameter-location": "method" + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions, this is different from cluster location", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json index 895caeb33e40..4cf2f6e17e02 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json @@ -1,1521 +1,1521 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceFabricManagementClient", - "description": "Azure Service Fabric Resource Provider API Client", - "version": "2018-02-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}": { - "get": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Get", - "summary": "Gets a Service Fabric cluster resource.", - "description": "Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "Get a cluster": { - "$ref": "./examples/ClusterGetOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "put": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Create", - "summary": "Creates or updates a Service Fabric cluster resource.", - "description": "Create or update a Service Fabric cluster resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "parameters", - "in": "body", - "description": "The cluster resource.", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-examples": { - "Put a cluster with mininum parameters": { - "$ref": "./examples/ClusterPutOperation_example_min.json" - }, - "Put a cluster with maximum parameters": { - "$ref": "./examples/ClusterPutOperation_example_max.json" - } - }, - "x-ms-long-running-operation": true, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "patch": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Update", - "summary": "Updates the configuration of a Service Fabric cluster resource.", - "description": "Update the configuration of a Service Fabric cluster resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "parameters", - "in": "body", - "description": "The parameters which contains the property value and property name which used to update the cluster configuration.", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpdateParameters" - }, - "x-ms-parameter-location": "method" - } - ], - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Patch a cluster": { - "$ref": "./examples/ClusterPatchOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "The request was accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "tags": [ - "Cluster" - ], - "operationId": "Clusters_Delete", - "summary": "Deletes a Service Fabric cluster resource.", - "description": "Delete a Service Fabric cluster resource with the specified name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/clusterNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "Delete a cluster": { - "$ref": "./examples/ClusterDeleteOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully." - }, - "204": { - "description": "The resource was not found." - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters": { - "get": { - "operationId": "Clusters_ListByResourceGroup", - "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", - "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "List cluster by resource group": { - "$ref": "./examples/ClusterListByResourceGroupOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters": { - "get": { - "operationId": "Clusters_List", - "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", - "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "tags": [ - "Cluster" - ], - "x-ms-examples": { - "List clusters": { - "$ref": "./examples/ClusterListOperation_example.json" - } - }, - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "The detailed error response.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}": { - "get": { - "operationId": "ClusterVersions_Get", - "summary": "Gets information about a Service Fabric cluster code version available in the specified location.", - "description": "Gets information about an available Service Fabric cluster code version.", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/clusterVersion" - } - ], - "x-ms-examples": { - "Get cluster version": { - "$ref": "./examples/ClusterVersionsGet_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}": { - "get": { - "operationId": "ClusterVersions_GetByEnvironment", - "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", - "description": "Gets information about an available Service Fabric cluster code version by environment.", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/environment" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/clusterVersion" - } - ], - "x-ms-examples": { - "Get cluster version by environment": { - "$ref": "./examples/ClusterVersionsGetByEnvironment_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions": { - "get": { - "operationId": "ClusterVersions_List", - "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", - "description": "Gets all available code versions for Service Fabric cluster resources by location.", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "List cluster versions": { - "$ref": "./examples/ClusterVersionsList_example.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions": { - "get": { - "operationId": "ClusterVersions_ListByEnvironment", - "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", - "description": "Gets all available code versions for Service Fabric cluster resources by environment.", - "parameters": [ - { - "$ref": "#/parameters/locationForClusterCodeVersions" - }, - { - "$ref": "#/parameters/environment" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "x-ms-examples": { - "List cluster versions by environment": { - "$ref": "./examples/ClusterVersionsListByEnvironment.json" - } - }, - "tags": [ - "ClusterVersion" - ], - "responses": { - "200": { - "description": "The operation completed successfully.", - "schema": { - "$ref": "#/definitions/ClusterCodeVersionsListResult" - } - } - } - } - }, - "/providers/Microsoft.ServiceFabric/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Lists all of the available Service Fabric resource provider API operations.", - "description": "Get the list of available Service Fabric resource provider API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "name": "api-version", - "in": "query", - "description": "The version of the Service Fabric resouce provider API", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "AddOnFeatures": { - "type": "string", - "description": "Available cluster add-on features", - "enum": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - }, - "ApplicationDeltaHealthPolicy": { - "type": "object", - "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n", - "properties": { - "defaultServiceTypeDeltaHealthPolicy": { - "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy", - "description": "The delta health policy used by default to evaluate the health of a service type when upgrading the cluster." - }, - "serviceTypeDeltaHealthPolicies": { - "$ref": "#/definitions/ServiceTypeDeltaHealthPolicyMap", - "description": "The map with service type delta health policy per service type name. The map is empty by default." - } - } - }, - "ApplicationDeltaHealthPolicyMap": { - "type": "object", - "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", - "additionalProperties": { - "$ref": "#/definitions/ApplicationDeltaHealthPolicy" - } - }, - "ApplicationHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", - "properties": { - "defaultServiceTypeHealthPolicy": { - "$ref": "#/definitions/ServiceTypeHealthPolicy", - "description": "The health policy used by default to evaluate the health of a service type." - }, - "serviceTypeHealthPolicies": { - "$ref": "#/definitions/ServiceTypeHealthPolicyMap", - "description": "The map with service type health policy per service type name. The map is empty by default." - } - } - }, - "ApplicationHealthPolicyMap": { - "type": "object", - "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", - "additionalProperties": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - }, - "AvailableOperationDisplay": { - "properties": { - "provider": { - "type": "string", - "description": "The name of the provider." - }, - "resource": { - "type": "string", - "description": "The resource on which the operation is performed" - }, - "operation": { - "type": "string", - "description": "The operation that can be performed." - }, - "description": { - "type": "string", - "description": "Operation description" - } - }, - "description": "Operation supported by Service Fabric resource provider" - }, - "AzureActiveDirectory": { - "properties": { - "tenantId": { - "type": "string", - "description": "Azure active directory tenant id." - }, - "clusterApplication": { - "type": "string", - "description": "Azure active directory cluster application id." - }, - "clientApplication": { - "type": "string", - "description": "Azure active directory client application id." - } - }, - "description": "The settings to enable AAD authentication on the cluster." - }, - "CertificateDescription": { - "required": [ - "thumbprint" - ], - "properties": { - "thumbprint": { - "type": "string", - "description": "Thumbprint of the primary certificate." - }, - "thumbprintSecondary": { - "type": "string", - "description": "Thumbprint of the secondary certificate." - }, - "x509StoreName": { - "$ref": "#/definitions/StoreName", - "description": "The local certificate store location." - } - }, - "description": "Describes the certificate details." - }, - "ClientCertificateCommonName": { - "required": [ - "certificateCommonName", - "isAdmin", - "certificateIssuerThumbprint" - ], - "properties": { - "isAdmin": { - "type": "boolean", - "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." - }, - "certificateCommonName": { - "type": "string", - "description": "The common name of the client certificate." - }, - "certificateIssuerThumbprint": { - "type": "string", - "description": "The issuer thumbprint of the client certificate." - } - }, - "description": "Describes the client certificate details using common name." - }, - "ClientCertificateThumbprint": { - "required": [ - "certificateThumbprint", - "isAdmin" - ], - "properties": { - "isAdmin": { - "type": "boolean", - "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." - }, - "certificateThumbprint": { - "type": "string", - "description": "The thumbprint of the client certificate." - } - }, - "description": "Describes the client certificate details using thumbprint." - }, - "Cluster": { - "type": "object", - "description": "The cluster resource\n", - "allOf": [ - { - "description": "The cluster resource properties" - }, - { - "$ref": "#/definitions/Resource" - }, - { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterProperties", - "description": "The cluster resource properties" - } - } - } - ] - }, - "ClusterCodeVersionsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClusterCodeVersionsResult" - } - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "The list results of the ServiceFabric runtime versions." - }, - "ClusterCodeVersionsResult": { - "properties": { - "id": { - "type": "string", - "description": "The identification of the result" - }, - "name": { - "type": "string", - "description": "The name of the result" - }, - "type": { - "type": "string", - "description": "The result resource type" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterVersionDetails", - "description": "The detail of the Service Fabric runtime version result" - } - }, - "description": "The result of the ServiceFabric runtime versions" - }, - "ClusterEnvironment": { - "type": "string", - "description": "Cluster operating system, the default will be Windows", - "enum": [ - "Windows", - "Linux" - ] - }, - "ClusterHealthPolicy": { - "type": "object", - "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n", - "properties": { - "maxPercentUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n", - "default": 0, - "minimum": 0, - "maximum": 100 - }, - "maxPercentUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n", - "default": 0, - "minimum": 0, - "maximum": 100 - }, - "applicationHealthPolicies": { - "$ref": "#/definitions/ApplicationHealthPolicyMap", - "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." - } - } - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Cluster list results" - }, - "ClusterProperties": { - "required": [ - "managementEndpoint", - "nodeTypes" - ], - "properties": { - "addOnFeatures": { - "type": "array", - "description": "The list of add-on features to enable in the cluster.", - "items": { - "$ref": "#/definitions/AddOnFeatures" - } - }, - "availableClusterVersions": { - "type": "array", - "description": "The Service Fabric runtime versions available for this cluster.", - "readOnly": true, - "items": { - "$ref": "#/definitions/ClusterVersionDetails" - } - }, - "azureActiveDirectory": { - "$ref": "#/definitions/AzureActiveDirectory", - "description": "The AAD authentication settings of the cluster." - }, - "certificate": { - "$ref": "#/definitions/CertificateDescription", - "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." - }, - "certificateCommonNames": { - "$ref": "#/definitions/ServerCertificateCommonNames", - "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." - }, - "clientCertificateCommonNames": { - "type": "array", - "description": "The list of client certificates referenced by common name that are allowed to manage the cluster.", - "items": { - "$ref": "#/definitions/ClientCertificateCommonName" - } - }, - "clientCertificateThumbprints": { - "type": "array", - "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster.", - "items": { - "$ref": "#/definitions/ClientCertificateThumbprint" - } - }, - "clusterCodeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." - }, - "clusterEndpoint": { - "type": "string", - "description": "The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.", - "readOnly": true - }, - "clusterId": { - "type": "string", - "description": "A service generated unique identifier for the cluster resource.", - "readOnly": true - }, - "clusterState": { - "readOnly": true, - "$ref": "#/definitions/ClusterState", - "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n" - }, - "diagnosticsStorageAccountConfig": { - "$ref": "#/definitions/DiagnosticsStorageAccountConfig", - "description": "The storage account information for storing Service Fabric diagnostic logs." - }, - "fabricSettings": { - "type": "array", - "description": "The list of custom fabric settings to configure the cluster.", - "items": { - "$ref": "#/definitions/SettingsSectionDescription" - } - }, - "managementEndpoint": { - "type": "string", - "description": "The http management endpoint of the cluster." - }, - "nodeTypes": { - "type": "array", - "description": "The list of node types in the cluster.", - "items": { - "$ref": "#/definitions/NodeTypeDescription" - } - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the cluster resource.", - "readOnly": true, - "enum": [ - "Updating", - "Succeeded", - "Failed", - "Canceled" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "reliabilityLevel": { - "$ref": "#/definitions/ReliabilityLevel", - "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" - }, - "reverseProxyCertificate": { - "$ref": "#/definitions/CertificateDescription", - "description": "The server certificate used by reverse proxy." - }, - "reverseProxyCertificateCommonNames": { - "$ref": "#/definitions/ServerCertificateCommonNames", - "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." - }, - "upgradeDescription": { - "$ref": "#/definitions/ClusterUpgradePolicy", - "description": "The policy to use when upgrading the cluster." - }, - "upgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" - }, - "vmImage": { - "type": "string", - "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." - } - }, - "description": "Describes the cluster resource properties." - }, - "ClusterPropertiesUpdateParameters": { - "properties": { - "addOnFeatures": { - "type": "array", - "description": "The list of add-on features to enable in the cluster.", - "items": { - "$ref": "#/definitions/AddOnFeatures" - } - }, - "certificate": { - "$ref": "#/definitions/CertificateDescription", - "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." - }, - "certificateCommonNames": { - "$ref": "#/definitions/ServerCertificateCommonNames", - "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." - }, - "clientCertificateCommonNames": { - "type": "array", - "description": "The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/ClientCertificateCommonName" - } - }, - "clientCertificateThumbprints": { - "type": "array", - "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/ClientCertificateThumbprint" - } - }, - "clusterCodeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." - }, - "fabricSettings": { - "type": "array", - "description": "The list of custom fabric settings to configure the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/SettingsSectionDescription" - } - }, - "nodeTypes": { - "type": "array", - "description": "The list of node types in the cluster. This will overwrite the existing list.", - "items": { - "$ref": "#/definitions/NodeTypeDescription" - } - }, - "reliabilityLevel": { - "$ref": "#/definitions/ReliabilityLevel", - "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" - }, - "reverseProxyCertificate": { - "$ref": "#/definitions/CertificateDescription", - "description": "The server certificate used by reverse proxy." - }, - "upgradeDescription": { - "$ref": "#/definitions/ClusterUpgradePolicy", - "description": "The policy to use when upgrading the cluster." - }, - "upgradeMode": { - "$ref": "#/definitions/UpgradeMode", - "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" - } - }, - "description": "Describes the cluster resource properties that can be updated during PATCH operation." - }, - "ClusterState": { - "type": "string", - "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n", - "enum": [ - "WaitingForNodes", - "Deploying", - "BaselineUpgrade", - "UpdatingUserConfiguration", - "UpdatingUserCertificate", - "UpdatingInfrastructure", - "EnforcingClusterVersion", - "UpgradeServiceUnreachable", - "AutoScale", - "Ready" - ] - }, - "ClusterUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ClusterPropertiesUpdateParameters", - "description": "Describes the cluster resource properties that can be updated during PATCH operation." - }, - "tags": { - "type": "object", - "description": "Cluster update parameters", - "additionalProperties": { - "type": "string" - } - } - }, - "description": "Cluster update request" - }, - "ClusterUpgradeDeltaHealthPolicy": { - "description": "Describes the delta health policies for the cluster upgrade.", - "required": [ - "maxPercentDeltaUnhealthyApplications", - "maxPercentDeltaUnhealthyNodes", - "maxPercentUpgradeDomainDeltaUnhealthyNodes" - ], - "properties": { - "maxPercentDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", - "minimum": 0, - "maximum": 100 - }, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer", - "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.\n", - "minimum": 0, - "maximum": 100 - }, - "maxPercentDeltaUnhealthyApplications": { - "type": "integer", - "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\n", - "minimum": 0, - "maximum": 100 - }, - "applicationDeltaHealthPolicies": { - "$ref": "#/definitions/ApplicationDeltaHealthPolicyMap", - "description": "Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster." - } - } - }, - "ClusterUpgradePolicy": { - "required": [ - "healthCheckRetryTimeout", - "healthCheckStableDuration", - "healthCheckWaitDuration", - "healthPolicy", - "upgradeDomainTimeout", - "upgradeReplicaSetCheckTimeout", - "upgradeTimeout" - ], - "properties": { - "forceRestart": { - "type": "boolean", - "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." - }, - "upgradeReplicaSetCheckTimeout": { - "type": "string", - "description": "The maximum amount of time to block processing of an upgrade domain and revent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckWaitDuration": { - "type": "string", - "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckStableDuration": { - "type": "string", - "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthCheckRetryTimeout": { - "type": "string", - "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "upgradeTimeout": { - "type": "string", - "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "upgradeDomainTimeout": { - "type": "string", - "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." - }, - "healthPolicy": { - "$ref": "#/definitions/ClusterHealthPolicy", - "description": "The cluster health policy used when upgrading the cluster." - }, - "deltaHealthPolicy": { - "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy", - "description": "The cluster delta health policy used when upgrading the cluster." - } - }, - "description": "Describes the policy used when upgrading the cluster." - }, - "ClusterVersionDetails": { - "properties": { - "codeVersion": { - "type": "string", - "description": "The Service Fabric runtime version of the cluster." - }, - "supportExpiryUtc": { - "type": "string", - "description": "The date of expiry of support of the version." - }, - "environment": { - "$ref": "#/definitions/ClusterEnvironment", - "description": "Indicates if this version is for Windows or Linux operating system." - } - }, - "description": "The detail of the Service Fabric runtime version result" - }, - "DiagnosticsStorageAccountConfig": { - "required": [ - "blobEndpoint", - "protectedAccountKeyName", - "queueEndpoint", - "storageAccountName", - "tableEndpoint" - ], - "properties": { - "storageAccountName": { - "type": "string", - "description": "The Azure storage account name." - }, - "protectedAccountKeyName": { - "type": "string", - "description": "The protected diagnostics storage key name." - }, - "blobEndpoint": { - "type": "string", - "description": "The blob endpoint of the azure storage account." - }, - "queueEndpoint": { - "type": "string", - "description": "The queue endpoint of the azure storage account." - }, - "tableEndpoint": { - "type": "string", - "description": "The table endpoint of the azure storage account." - } - }, - "description": "The storage account information for storing Service Fabric diagnostic logs." - }, - "DurabilityLevel": { - "type": "string", - "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n", - "enum": [ - "Bronze", - "Silver", - "Gold" - ] - }, - "EndpointRangeDescription": { - "required": [ - "endPort", - "startPort" - ], - "properties": { - "startPort": { - "type": "integer", - "description": "Starting port of a range of ports" - }, - "endPort": { - "type": "integer", - "description": "End port of a range of ports" - } - }, - "description": "Port range details" - }, - "NodeTypeDescription": { - "required": [ - "clientConnectionEndpointPort", - "httpGatewayEndpointPort", - "isPrimary", - "name", - "vmInstanceCount" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the node type." - }, - "placementProperties": { - "type": "object", - "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", - "additionalProperties": { - "type": "string", - "description": "Placement tag value" - } - }, - "capacities": { - "type": "object", - "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", - "additionalProperties": { - "type": "string", - "description": "Capacity tag value" - } - }, - "clientConnectionEndpointPort": { - "type": "integer", - "description": "The TCP cluster management endpoint port." - }, - "httpGatewayEndpointPort": { - "type": "integer", - "description": "The HTTP cluster management endpoint port." - }, - "durabilityLevel": { - "$ref": "#/definitions/DurabilityLevel", - "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n" - }, - "applicationPorts": { - "$ref": "#/definitions/EndpointRangeDescription", - "description": "The range of ports from which cluster assigned port to Service Fabric applications." - }, - "ephemeralPorts": { - "$ref": "#/definitions/EndpointRangeDescription", - "description": "The range of empheral ports that nodes in this node type should be configured with." - }, - "isPrimary": { - "type": "boolean", - "description": "The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters." - }, - "vmInstanceCount": { - "type": "integer", - "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", - "minimum": 1, - "maximum": 2147483647 - }, - "reverseProxyEndpointPort": { - "type": "integer", - "description": "The endpoint used by reverse proxy." - } - }, - "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." - }, - "OperationListResult": { - "properties": { - "value": { - "type": "array", - "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", - "items": { - "$ref": "#/definitions/OperationResult" - } - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - }, - "description": "Describes the result of the request to list Service Fabric operations." - }, - "OperationResult": { - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "$ref": "#/definitions/AvailableOperationDisplay", - "description": "The object that represents the operation." - }, - "origin": { - "type": "string", - "description": "Origin result" - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Available operation list result" - }, - "ReliabilityLevel": { - "type": "string", - "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", - "enum": [ - "None", - "Bronze", - "Silver", - "Gold", - "Platinum" - ] - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "type": "string", - "description": "Azure resource identifier.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Azure resource name.", - "readOnly": true - }, - "type": { - "type": "string", - "description": "Azure resource type.", - "readOnly": true - }, - "location": { - "type": "string", - "description": "Azure resource location.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { - "type": "object", - "description": "Azure resource tags.", - "additionalProperties": { - "type": "string" - } - } - }, - "description": "The resource model definition.", - "x-ms-azure-resource": true - }, - "ServerCertificateCommonName": { - "description": "Describes the server certificate details using common name.", - "required": [ - "certificateCommonName", - "certificateIssuerThumbprint" - ], - "properties": { - "certificateCommonName": { - "type": "string", - "description": "The common name of the server certificate." - }, - "certificateIssuerThumbprint": { - "type": "string", - "description": "The issuer thumbprint of the server certificate." - } - } - }, - "ServerCertificateCommonNames": { - "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster.", - "properties": { - "commonNames": { - "type": "array", - "description": "The list of server certificates referenced by common name that are used to secure the cluster.", - "items": { - "$ref": "#/definitions/ServerCertificateCommonName" - } - }, - "x509StoreName": { - "$ref": "#/definitions/StoreName", - "description": "The local certificate store location." - } - } - }, - "ServiceTypeDeltaHealthPolicy": { - "type": "object", - "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n", - "properties": { - "maxPercentDeltaUnhealthyServices": { - "type": "integer", - "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", - "default": 0, - "minimum": 0, - "maximum": 100 - } - } - }, - "ServiceTypeDeltaHealthPolicyMap": { - "type": "object", - "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n", - "additionalProperties": { - "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" - } - }, - "SettingsParameterDescription": { - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "The parameter name of fabric setting." - }, - "value": { - "type": "string", - "description": "The parameter value of fabric setting." - } - }, - "description": "Describes a parameter in fabric settings of the cluster." - }, - "SettingsSectionDescription": { - "required": [ - "name", - "parameters" - ], - "properties": { - "name": { - "type": "string", - "description": "The section name of the fabric settings." - }, - "parameters": { - "type": "array", - "description": "The collection of parameters in the section.", - "items": { - "$ref": "#/definitions/SettingsParameterDescription" - } - } - }, - "description": "Describes a section in the fabric settings of the cluster." - }, - "StoreName": { - "type": "string", - "description": "The local certificate store location.", - "enum": [ - "AddressBook", - "AuthRoot", - "CertificateAuthority", - "Disallowed", - "My", - "Root", - "TrustedPeople", - "TrustedPublisher" - ] - }, - "UpgradeMode": { - "type": "string", - "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n", - "enum": [ - "Automatic", - "Manual" - ] - }, - "ErrorModel": { - "properties": { - "error": { - "$ref": "#/definitions/ErrorModelError", - "description": "The error details." - } - }, - "description": "The structure of the error." - }, - "ErrorModelError": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "The error details." - }, - "ServiceTypeHealthPolicy": { - "type": "object", - "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", - "properties": { - "maxPercentUnhealthyServices": { - "type": "integer", - "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", - "default": 0, - "minimum": 0, - "maximum": 100 - } - } - }, - "ServiceTypeHealthPolicyMap": { - "type": "object", - "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", - "additionalProperties": { - "$ref": "#/definitions/ServiceTypeHealthPolicy" - } - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2018-02-01\" for this specification.", - "required": true, - "type": "string", - "enum": [ - "2018-02-01" - ], - "default": "2018-02-01", - "x-ms-parameter-location": "client" - }, - "clusterNameParameter": { - "name": "clusterName", - "in": "path", - "description": "The name of the cluster resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "clusterVersion": { - "name": "clusterVersion", - "in": "path", - "description": "The cluster code version.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "environment": { - "name": "environment", - "in": "path", - "description": "The operating system of the cluster. The default means all.", - "required": true, - "type": "string", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-parameter-location": "method" - }, - "locationForClusterCodeVersions": { - "name": "location", - "in": "path", - "description": "The location for the cluster code versions. This is different from cluster location.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The customer subscription identifier.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - } - } +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2018-02-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}": { + "get": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Get", + "summary": "Gets a Service Fabric cluster resource.", + "description": "Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Create", + "summary": "Creates or updates a Service Fabric cluster resource.", + "description": "Create or update a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with mininum parameters": { + "$ref": "./examples/ClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Update", + "summary": "Updates the configuration of a Service Fabric cluster resource.", + "description": "Update the configuration of a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters which contains the property value and property name which used to update the cluster configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch a cluster": { + "$ref": "./examples/ClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_Delete", + "summary": "Deletes a Service Fabric cluster resource.", + "description": "Delete a Service Fabric cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ClusterDeleteOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully." + }, + "204": { + "description": "The resource was not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters": { + "get": { + "operationId": "Clusters_List", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "List clusters": { + "$ref": "./examples/ClusterListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_Get", + "summary": "Gets information about a Service Fabric cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ClusterVersionsGet_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions/{clusterVersion}": { + "get": { + "operationId": "ClusterVersions_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ClusterVersionsGetByEnvironment_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ClusterVersionsList_example.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/clusterVersions": { + "get": { + "operationId": "ClusterVersions_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ClusterVersionsListByEnvironment.json" + } + }, + "tags": [ + "ClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ClusterCodeVersionsListResult" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resouce provider API", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AddOnFeatures": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + }, + "ApplicationDeltaHealthPolicy": { + "type": "object", + "description": "Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.\n", + "properties": { + "defaultServiceTypeDeltaHealthPolicy": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy", + "description": "The delta health policy used by default to evaluate the health of a service type when upgrading the cluster." + }, + "serviceTypeDeltaHealthPolicies": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicyMap", + "description": "The map with service type delta health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationDeltaHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific application delta health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationDeltaHealthPolicy used to evaluate the application health when upgrading the cluster.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicy" + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "properties": { + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicies": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nThe application name should include the 'fabric:' URI scheme.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by Service Fabric resource provider" + }, + "AzureActiveDirectory": { + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "CertificateDescription": { + "required": [ + "thumbprint" + ], + "properties": { + "thumbprint": { + "type": "string", + "description": "Thumbprint of the primary certificate." + }, + "thumbprintSecondary": { + "type": "string", + "description": "Thumbprint of the secondary certificate." + }, + "x509StoreName": { + "$ref": "#/definitions/StoreName", + "description": "The local certificate store location." + } + }, + "description": "Describes the certificate details." + }, + "ClientCertificateCommonName": { + "required": [ + "certificateCommonName", + "isAdmin", + "certificateIssuerThumbprint" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateCommonName": { + "type": "string", + "description": "The common name of the client certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using common name." + }, + "ClientCertificateThumbprint": { + "required": [ + "certificateThumbprint", + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "certificateThumbprint": { + "type": "string", + "description": "The thumbprint of the client certificate." + } + }, + "description": "Describes the client certificate details using thumbprint." + }, + "Cluster": { + "type": "object", + "description": "The cluster resource\n", + "allOf": [ + { + "description": "The cluster resource properties" + }, + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "The cluster resource properties" + } + } + } + ] + }, + "ClusterCodeVersionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterCodeVersionsResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "The list results of the ServiceFabric runtime versions." + }, + "ClusterCodeVersionsResult": { + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterVersionDetails", + "description": "The detail of the Service Fabric runtime version result" + } + }, + "description": "The result of the ServiceFabric runtime versions" + }, + "ClusterEnvironment": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows", + "Linux" + ] + }, + "ClusterHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.\n", + "properties": { + "maxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + }, + "applicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Cluster list results" + }, + "ClusterProperties": { + "required": [ + "managementEndpoint", + "nodeTypes" + ], + "properties": { + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + }, + "availableClusterVersions": { + "type": "array", + "description": "The Service Fabric runtime versions available for this cluster.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ClusterVersionDetails" + } + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "certificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." + }, + "certificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterEndpoint": { + "type": "string", + "description": "The Azure Resource Provider endpoint. A system service in the cluster connects to this endpoint.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n" + }, + "diagnosticsStorageAccountConfig": { + "$ref": "#/definitions/DiagnosticsStorageAccountConfig", + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "managementEndpoint": { + "type": "string", + "description": "The http management endpoint of the cluster." + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the cluster resource.", + "readOnly": true, + "enum": [ + "Updating", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "reliabilityLevel": { + "$ref": "#/definitions/ReliabilityLevel", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" + }, + "reverseProxyCertificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The server certificate used by reverse proxy." + }, + "reverseProxyCertificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "upgradeDescription": { + "$ref": "#/definitions/ClusterUpgradePolicy", + "description": "The policy to use when upgrading the cluster." + }, + "upgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" + }, + "vmImage": { + "type": "string", + "description": "The VM image VMSS has been configured with. Generic names such as Windows or Linux can be used." + } + }, + "description": "Describes the cluster resource properties." + }, + "ClusterPropertiesUpdateParameters": { + "properties": { + "addOnFeatures": { + "type": "array", + "description": "The list of add-on features to enable in the cluster.", + "items": { + "$ref": "#/definitions/AddOnFeatures" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The certificate to use for securing the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client." + }, + "certificateCommonNames": { + "$ref": "#/definitions/ServerCertificateCommonNames", + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster." + }, + "clientCertificateCommonNames": { + "type": "array", + "description": "The list of client certificates referenced by common name that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateCommonName" + } + }, + "clientCertificateThumbprints": { + "type": "array", + "description": "The list of client certificates referenced by thumbprint that are allowed to manage the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/ClientCertificateThumbprint" + } + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property can only by set the user when **upgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "fabricSettings": { + "type": "array", + "description": "The list of custom fabric settings to configure the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + } + }, + "nodeTypes": { + "type": "array", + "description": "The list of node types in the cluster. This will overwrite the existing list.", + "items": { + "$ref": "#/definitions/NodeTypeDescription" + } + }, + "reliabilityLevel": { + "$ref": "#/definitions/ReliabilityLevel", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n" + }, + "reverseProxyCertificate": { + "$ref": "#/definitions/CertificateDescription", + "description": "The server certificate used by reverse proxy." + }, + "upgradeDescription": { + "$ref": "#/definitions/ClusterUpgradePolicy", + "description": "The policy to use when upgrading the cluster." + }, + "upgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n" + } + }, + "description": "Describes the cluster resource properties that can be updated during PATCH operation." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n\n - WaitingForNodes - Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it.\n - Deploying - Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.\n - BaselineUpgrade - Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.\n - UpdatingUserConfiguration - Indicates that the cluster is being upgraded with the user provided configuration.\n - UpdatingUserCertificate - Indicates that the cluster is being upgraded with the user provided certificate.\n - UpdatingInfrastructure - Indicates that the cluster is being upgraded with the latest Service Fabric runtime version. This happens only when the **upgradeMode** is set to 'Automatic'.\n - EnforcingClusterVersion - Indicates that cluster is on a different version than expected and the cluster is being upgraded to the expected version.\n - UpgradeServiceUnreachable - Indicates that the system service in the cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.\n - AutoScale - Indicates that the ReliabilityLevel of the cluster is being adjusted.\n - Ready - Indicates that the cluster is in a stable state.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "UpdatingUserConfiguration", + "UpdatingUserCertificate", + "UpdatingInfrastructure", + "EnforcingClusterVersion", + "UpgradeServiceUnreachable", + "AutoScale", + "Ready" + ] + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterPropertiesUpdateParameters", + "description": "Describes the cluster resource properties that can be updated during PATCH operation." + }, + "tags": { + "type": "object", + "description": "Cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Cluster update request" + }, + "ClusterUpgradeDeltaHealthPolicy": { + "description": "Describes the delta health policies for the cluster upgrade.", + "required": [ + "maxPercentDeltaUnhealthyApplications", + "maxPercentDeltaUnhealthyNodes", + "maxPercentUpgradeDomainDeltaUnhealthyNodes" + ], + "properties": { + "maxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentDeltaUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of applications health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this.\n", + "minimum": 0, + "maximum": 100 + }, + "applicationDeltaHealthPolicies": { + "$ref": "#/definitions/ApplicationDeltaHealthPolicyMap", + "description": "Defines the application delta health policy map used to evaluate the health of an application or one of its child entities when upgrading the cluster." + } + } + }, + "ClusterUpgradePolicy": { + "required": [ + "healthCheckRetryTimeout", + "healthCheckStableDuration", + "healthCheckWaitDuration", + "healthPolicy", + "upgradeDomainTimeout", + "upgradeReplicaSetCheckTimeout", + "upgradeTimeout" + ], + "properties": { + "forceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "upgradeReplicaSetCheckTimeout": { + "type": "string", + "description": "The maximum amount of time to block processing of an upgrade domain and revent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckWaitDuration": { + "type": "string", + "description": "The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "upgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format." + }, + "healthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "The cluster health policy used when upgrading the cluster." + }, + "deltaHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeDeltaHealthPolicy", + "description": "The cluster delta health policy used when upgrading the cluster." + } + }, + "description": "Describes the policy used when upgrading the cluster." + }, + "ClusterVersionDetails": { + "properties": { + "codeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "environment": { + "$ref": "#/definitions/ClusterEnvironment", + "description": "Indicates if this version is for Windows or Linux operating system." + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "DiagnosticsStorageAccountConfig": { + "required": [ + "blobEndpoint", + "protectedAccountKeyName", + "queueEndpoint", + "storageAccountName", + "tableEndpoint" + ], + "properties": { + "storageAccountName": { + "type": "string", + "description": "The Azure storage account name." + }, + "protectedAccountKeyName": { + "type": "string", + "description": "The protected diagnostics storage key name." + }, + "blobEndpoint": { + "type": "string", + "description": "The blob endpoint of the azure storage account." + }, + "queueEndpoint": { + "type": "string", + "description": "The queue endpoint of the azure storage account." + }, + "tableEndpoint": { + "type": "string", + "description": "The table endpoint of the azure storage account." + } + }, + "description": "The storage account information for storing Service Fabric diagnostic logs." + }, + "DurabilityLevel": { + "type": "string", + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n", + "enum": [ + "Bronze", + "Silver", + "Gold" + ] + }, + "EndpointRangeDescription": { + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "NodeTypeDescription": { + "required": [ + "clientConnectionEndpointPort", + "httpGatewayEndpointPort", + "isPrimary", + "name", + "vmInstanceCount" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the node type." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "clientConnectionEndpointPort": { + "type": "integer", + "description": "The TCP cluster management endpoint port." + }, + "httpGatewayEndpointPort": { + "type": "integer", + "description": "The HTTP cluster management endpoint port." + }, + "durabilityLevel": { + "$ref": "#/definitions/DurabilityLevel", + "description": "The durability level of the node type. Learn about [DurabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - Bronze - No privileges. This is the default.\n - Silver - The infrastructure jobs can be paused for a duration of 10 minutes per UD.\n - Gold - The infrastructure jobs can be paused for a duration of 2 hours per UD. Gold durability can be enabled only on full node VM skus like D15_V2, G5 etc.\n" + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of empheral ports that nodes in this node type should be configured with." + }, + "isPrimary": { + "type": "boolean", + "description": "The node type on which system services will run. Only one node type should be marked as primary. Primary node type cannot be deleted or changed for existing clusters." + }, + "vmInstanceCount": { + "type": "integer", + "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", + "minimum": 1, + "maximum": 2147483647 + }, + "reverseProxyEndpointPort": { + "type": "integer", + "description": "The endpoint used by reverse proxy." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "ReliabilityLevel": { + "type": "string", + "description": "The reliability level sets the replica set size of system services. Learn about [ReliabilityLevel](https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).\n\n - None - Run the System services with a target replica set count of 1. This should only be used for test clusters.\n - Bronze - Run the System services with a target replica set count of 3. This should only be used for test clusters.\n - Silver - Run the System services with a target replica set count of 5.\n - Gold - Run the System services with a target replica set count of 7.\n - Platinum - Run the System services with a target replica set count of 9.\n", + "enum": [ + "None", + "Bronze", + "Silver", + "Gold", + "Platinum" + ] + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "ServerCertificateCommonName": { + "description": "Describes the server certificate details using common name.", + "required": [ + "certificateCommonName", + "certificateIssuerThumbprint" + ], + "properties": { + "certificateCommonName": { + "type": "string", + "description": "The common name of the server certificate." + }, + "certificateIssuerThumbprint": { + "type": "string", + "description": "The issuer thumbprint of the server certificate." + } + } + }, + "ServerCertificateCommonNames": { + "description": "Describes a list of server certificates referenced by common name that are used to secure the cluster.", + "properties": { + "commonNames": { + "type": "array", + "description": "The list of server certificates referenced by common name that are used to secure the cluster.", + "items": { + "$ref": "#/definitions/ServerCertificateCommonName" + } + }, + "x509StoreName": { + "$ref": "#/definitions/StoreName", + "description": "The local certificate store location." + } + } + }, + "ServiceTypeDeltaHealthPolicy": { + "type": "object", + "description": "Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.\n", + "properties": { + "maxPercentDeltaUnhealthyServices": { + "type": "integer", + "description": "The maximum allowed percentage of services health degradation allowed during cluster upgrades.\nThe delta is measured between the state of the services at the beginning of upgrade and the state of the services at the time of the health evaluation.\nThe check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeDeltaHealthPolicyMap": { + "type": "object", + "description": "Defines a map that contains specific delta health policies for different service types.\nEach entry specifies as key the service type name and as value a ServiceTypeDeltaHealthPolicy used to evaluate the service health when upgrading the cluster.\nThe map is empty by default.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeDeltaHealthPolicy" + } + }, + "SettingsParameterDescription": { + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + } + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "StoreName": { + "type": "string", + "description": "The local certificate store location.", + "enum": [ + "AddressBook", + "AuthRoot", + "CertificateAuthority", + "Disallowed", + "My", + "Root", + "TrustedPeople", + "TrustedPublisher" + ] + }, + "UpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n\n - Automatic - The cluster will be automatically upgraded to the latest Service Fabric runtime version as soon as it is available.\n - Manual - The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource.\n", + "enum": [ + "Automatic", + "Manual" + ] + }, + "ErrorModel": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum percentage of services allowed to be unhealthy before your application is considered in error.\n", + "default": 0, + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2018-02-01\" for this specification.", + "required": true, + "type": "string", + "enum": [ + "2018-02-01" + ], + "default": "2018-02-01", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-parameter-location": "method" + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } } \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json index d62c64fe7d71..90e653549b2e 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterDeleteOperation_example.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {} - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {} + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json index 1980c186e390..6acdfd70168e 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterGetOperation_example.json @@ -1,159 +1,159 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": true, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0, - "applicationHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0 - }, - "serviceTypeHealthPolicies": { - "myServiceType1": { - "maxPercentUnhealthyServices": 100 - } - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 0 - }, - "serviceTypeDeltaHealthPolicies": { - "myServiceType1": { - "maxPercentDeltaUnhealthyServices": 0 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ], - "addOnFeatures": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json index 1d4353c59482..2aaacc3cc1e2 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListByResourceGroupOperation_example.json @@ -1,248 +1,248 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0, - "applicationHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0 - }, - "serviceTypeHealthPolicies": { - "myServiceType1": { - "maxPercentUnhealthyServices": 100 - } - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 0 - }, - "serviceTypeDeltaHealthPolicies": { - "myServiceType1": { - "maxPercentDeltaUnhealthyServices": 0 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ], - "addOnFeatures": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - } - }, - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", - "name": "myCluster2", - "tags": {}, - "etag": "W/\"636462502164040075\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", - "clusterCodeVersion": "6.1.187.1", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Ubuntu", - "reliabilityLevel": "Silver", - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.187.1", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Linux" - } - ], - "addonFeatures": [ - "RepairManager" - ] - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json index 1ae0df7e692c..35db5425f9a5 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterListOperation_example.json @@ -1,247 +1,247 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0, - "applicationHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0 - }, - "serviceTypeHealthPolicies": { - "myServiceType1": { - "maxPercentUnhealthyServices": 100 - } - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 0 - }, - "serviceTypeDeltaHealthPolicies": { - "myServiceType1": { - "maxPercentDeltaUnhealthyServices": 0 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ], - "addOnFeatures": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - } - }, - { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", - "name": "myCluster2", - "tags": {}, - "etag": "W/\"636462502164040075\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", - "clusterCodeVersion": "6.1.187.1", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Ubuntu", - "reliabilityLevel": "Silver", - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.187.1", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Linux" - } - ], - "addonFeatures": [ - "RepairManager" - ] - } - } - ], - "nextLink": "" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + }, + { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "6.1.187.1", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster2.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Ubuntu", + "reliabilityLevel": "Silver", + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + ], + "addonFeatures": [ + "RepairManager" + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json index 03f10ed3b62c..c78e9c65e6db 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPatchOperation_example.json @@ -1,171 +1,171 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2018-02-01", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": { - "a": "b" - }, - "properties": { - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - }, - { - "name": "testnt1", - "clientConnectionEndpointPort": 0, - "httpGatewayEndpointPort": 0, - "applicationPorts": { - "startPort": 1000, - "endPort": 2000 - }, - "ephemeralPorts": { - "startPort": 3000, - "endPort": 4000 - }, - "isPrimary": false, - "vmInstanceCount": 3, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Bronze", - "upgradeMode": "Default" - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2018-02-01" - }, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": { - "a": "b" - }, - "etag": "W/\"636462502169240744\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - }, - { - "name": "testnt1", - "clientConnectionEndpointPort": 0, - "httpGatewayEndpointPort": 0, - "applicationPorts": { - "startPort": 1000, - "endPort": 2000 - }, - "ephemeralPorts": { - "startPort": 3000, - "endPort": 4000 - }, - "isPrimary": false, - "vmInstanceCount": 3, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Bronze", - "upgradeMode": "Automatic", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "properties": { + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Default" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2018-02-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "etag": "W/\"636462502169240744\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + }, + { + "name": "testnt1", + "clientConnectionEndpointPort": 0, + "httpGatewayEndpointPort": 0, + "applicationPorts": { + "startPort": 1000, + "endPort": 2000 + }, + "ephemeralPorts": { + "startPort": 3000, + "endPort": 4000 + }, + "isPrimary": false, + "vmInstanceCount": 3, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Bronze", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json index f924fc6a9762..8a28b3e78266 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_max.json @@ -1,296 +1,296 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2018-02-01", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "properties": { - "clusterCodeVersion": "6.1.480.9494", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": true, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "01:00:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0, - "applicationHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0 - }, - "serviceTypeHealthPolicies": { - "myServiceType1": { - "maxPercentUnhealthyServices": 100 - } - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 0 - }, - "serviceTypeDeltaHealthPolicies": { - "myServiceType1": { - "maxPercentDeltaUnhealthyServices": 0 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "addOnFeatures": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - } - } - }, - "responses": { - "202": { - "headers": { - "Retry-After": "10", - "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2018-02-01" - }, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240745\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "certificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "clientCertificateThumbprints": [ - { - "isAdmin": false, - "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "clientCertificateCommonNames": [ - { - "isAdmin": true, - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" - } - ], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": true, - "upgradeReplicaSetCheckTimeout": "00:10:00", - "healthCheckWaitDuration": "00:00:30", - "healthCheckStableDuration": "00:00:30", - "healthCheckRetryTimeout": "00:05:00", - "upgradeTimeout": "00:15:00", - "upgradeDomainTimeout": "00:15:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 0, - "maxPercentUnhealthyApplications": 0, - "applicationHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeHealthPolicy": { - "maxPercentUnhealthyServices": 0 - }, - "serviceTypeHealthPolicies": { - "myServiceType1": { - "maxPercentUnhealthyServices": 100 - } - } - } - } - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0, - "applicationDeltaHealthPolicies": { - "fabric:/myApp1": { - "defaultServiceTypeDeltaHealthPolicy": { - "maxPercentDeltaUnhealthyServices": 0 - }, - "serviceTypeDeltaHealthPolicies": { - "myServiceType1": { - "maxPercentDeltaUnhealthyServices": 0 - } - } - } - } - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "vmImage": "Windows", - "azureActiveDirectory": { - "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", - "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", - "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" - }, - "reliabilityLevel": "Silver", - "reverseProxyCertificateCommonNames": { - "commonNames": [ - { - "certificateCommonName": "abc.com", - "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" - } - ], - "x509StoreName": "My" - }, - "upgradeMode": "Manual", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ], - "addonFeatures": [ - "RepairManager", - "DnsService", - "BackupRestoreService", - "ResourceMonitorService" - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "clusterCodeVersion": "6.1.480.9494", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": true, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "01:00:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "addOnFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4b5f6709-bc12-4365-8df3-894984b2a221?api-version=2018-02-01" + }, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "https://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "certificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "clientCertificateThumbprints": [ + { + "isAdmin": false, + "certificateThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "clientCertificateCommonNames": [ + { + "isAdmin": true, + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "5F3660C715EBBDA31DB1FFDCF508302348DE8E7A" + } + ], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": true, + "upgradeReplicaSetCheckTimeout": "00:10:00", + "healthCheckWaitDuration": "00:00:30", + "healthCheckStableDuration": "00:00:30", + "healthCheckRetryTimeout": "00:05:00", + "upgradeTimeout": "00:15:00", + "upgradeDomainTimeout": "00:15:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 0, + "maxPercentUnhealthyApplications": 0, + "applicationHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0 + }, + "serviceTypeHealthPolicies": { + "myServiceType1": { + "maxPercentUnhealthyServices": 100 + } + } + } + } + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0, + "applicationDeltaHealthPolicies": { + "fabric:/myApp1": { + "defaultServiceTypeDeltaHealthPolicy": { + "maxPercentDeltaUnhealthyServices": 0 + }, + "serviceTypeDeltaHealthPolicies": { + "myServiceType1": { + "maxPercentDeltaUnhealthyServices": 0 + } + } + } + } + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "vmImage": "Windows", + "azureActiveDirectory": { + "tenantId": "6abcc6a0-8666-43f1-87b8-172cf86a9f9c", + "clusterApplication": "5886372e-7bf4-4878-a497-8098aba608ae", + "clientApplication": "d151ad89-4bce-4ae8-b3d1-1dc79679fa75" + }, + "reliabilityLevel": "Silver", + "reverseProxyCertificateCommonNames": { + "commonNames": [ + { + "certificateCommonName": "abc.com", + "certificateIssuerThumbprint": "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + } + ], + "x509StoreName": "My" + }, + "upgradeMode": "Manual", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ], + "addonFeatures": [ + "RepairManager", + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json index 76759d3a8a62..01024f9af8e7 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterPutOperation_example_min.json @@ -1,142 +1,142 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2018-02-01", - "parameters": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "properties": { - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Silver", - "upgradeMode": "Automatic" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "type": "Microsoft.ServiceFabric/clusters", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", - "name": "myCluster", - "tags": {}, - "etag": "W/\"636462502169240743\"", - "properties": { - "provisioningState": "Succeeded", - "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", - "clusterCodeVersion": "6.1.480.9494", - "clusterState": "WaitingForNodes", - "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", - "clusterEndpoint": "https://eastus.servicefabric.azure.com", - "clientCertificateThumbprints": [], - "clientCertificateCommonNames": [], - "fabricSettings": [ - { - "name": "UpgradeService", - "parameters": [ - { - "name": "AppPollIntervalInSeconds", - "value": "60" - } - ] - } - ], - "upgradeDescription": { - "forceRestart": false, - "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", - "healthCheckWaitDuration": "00:05:00", - "healthCheckStableDuration": "00:05:00", - "healthCheckRetryTimeout": "00:45:00", - "upgradeTimeout": "12:00:00", - "upgradeDomainTimeout": "02:00:00", - "healthPolicy": { - "maxPercentUnhealthyNodes": 100, - "maxPercentUnhealthyApplications": 100 - }, - "deltaHealthPolicy": { - "maxPercentDeltaUnhealthyNodes": 0, - "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, - "maxPercentDeltaUnhealthyApplications": 0 - } - }, - "diagnosticsStorageAccountConfig": { - "storageAccountName": "diag", - "protectedAccountKeyName": "StorageAccountKey1", - "blobEndpoint": "https://diag.blob.core.windows.net/", - "queueEndpoint": "https://diag.queue.core.windows.net/", - "tableEndpoint": "https://diag.table.core.windows.net/" - }, - "nodeTypes": [ - { - "name": "nt1vm", - "clientConnectionEndpointPort": 19000, - "httpGatewayEndpointPort": 19007, - "applicationPorts": { - "startPort": 20000, - "endPort": 30000 - }, - "ephemeralPorts": { - "startPort": 49000, - "endPort": 64000 - }, - "isPrimary": true, - "vmInstanceCount": 5, - "durabilityLevel": "Bronze" - } - ], - "reliabilityLevel": "Silver", - "upgradeMode": "Automatic", - "availableClusterVersions": [ - { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - ] - } - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2018-02-01", + "parameters": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "properties": { + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/clusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240743\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "6.1.480.9494", + "clusterState": "WaitingForNodes", + "managementEndpoint": "http://myCluster.eastus.cloudapp.azure.com:19080", + "clusterEndpoint": "https://eastus.servicefabric.azure.com", + "clientCertificateThumbprints": [], + "clientCertificateCommonNames": [], + "fabricSettings": [ + { + "name": "UpgradeService", + "parameters": [ + { + "name": "AppPollIntervalInSeconds", + "value": "60" + } + ] + } + ], + "upgradeDescription": { + "forceRestart": false, + "upgradeReplicaSetCheckTimeout": "10675199.02:48:05.4775807", + "healthCheckWaitDuration": "00:05:00", + "healthCheckStableDuration": "00:05:00", + "healthCheckRetryTimeout": "00:45:00", + "upgradeTimeout": "12:00:00", + "upgradeDomainTimeout": "02:00:00", + "healthPolicy": { + "maxPercentUnhealthyNodes": 100, + "maxPercentUnhealthyApplications": 100 + }, + "deltaHealthPolicy": { + "maxPercentDeltaUnhealthyNodes": 0, + "maxPercentUpgradeDomainDeltaUnhealthyNodes": 0, + "maxPercentDeltaUnhealthyApplications": 0 + } + }, + "diagnosticsStorageAccountConfig": { + "storageAccountName": "diag", + "protectedAccountKeyName": "StorageAccountKey1", + "blobEndpoint": "https://diag.blob.core.windows.net/", + "queueEndpoint": "https://diag.queue.core.windows.net/", + "tableEndpoint": "https://diag.table.core.windows.net/" + }, + "nodeTypes": [ + { + "name": "nt1vm", + "clientConnectionEndpointPort": 19000, + "httpGatewayEndpointPort": 19007, + "applicationPorts": { + "startPort": 20000, + "endPort": 30000 + }, + "ephemeralPorts": { + "startPort": 49000, + "endPort": 64000 + }, + "isPrimary": true, + "vmInstanceCount": 5, + "durabilityLevel": "Bronze" + } + ], + "reliabilityLevel": "Silver", + "upgradeMode": "Automatic", + "availableClusterVersions": [ + { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + ] + } + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json index 3c06067f37bd..183ac30245ca 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGetByEnvironment_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "environment": "Windows", - "clusterVersion": "6.1.480.9494", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", - "name": "6.1.480.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "6.1.480.9494", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json index b8477ec5c74a..1bb37b4d0e42 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsGet_example.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "clusterVersion": "6.1.480.9494", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", - "name": "6.1.480.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "6.1.480.9494", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json index 47648aa8fbab..248c58118a46 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsListByEnvironment.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "environment": "Windows", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", - "name": "6.1.480.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json index 710991ecdd61..476269535509 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/stable/2018-02-01/examples/ClusterVersionsList_example.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", - "name": "6.1.480.9494", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.1.480.9494", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Windows" - } - }, - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1", - "name": "6.1.187.1", - "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", - "properties": { - "codeVersion": "6.1.187.1", - "supportExpiryUtc": "2018-06-15T23:59:59.9999999", - "environment": "Linux" - } - } - ] - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/clusterVersions/6.1.480.9494", + "name": "6.1.480.9494", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.480.9494", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Windows" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Linux/clusterVersions/6.1.187.1", + "name": "6.1.187.1", + "type": "Microsoft.ServiceFabric/locations/environments/clusterVersions", + "properties": { + "codeVersion": "6.1.187.1", + "supportExpiryUtc": "2018-06-15T23:59:59.9999999", + "environment": "Linux" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json index ce3e4db488e7..3e33d3bf56f1 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json @@ -1,83 +1,83 @@ -{ - "operationId":"Application_Create", - "description":"This example shows how to create or update an application resource.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "helloWorldApp", - "applicationResourceDescription": { - "properties": { - "description": "SeaBreeze HelloWorld Application!", - "services": [ - { - "properties": { - "osType": "linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "description": "SeaBreeze Hello World Service.", - "replicaCount": 1 - }, - "name": "helloWorldService" - } - ] - }, - "tags": {}, - "location": "EastUS" - } - }, - "responses": { - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", - "name": "myHelloWorldApp", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Invalid" - } - } - }, - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", - "name": "myHelloWorldApp", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Invalid" - } - } - } - } +{ + "operationId":"Application_Create", + "description":"This example shows how to create or update an application resource.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "applicationResourceDescription": { + "properties": { + "description": "SeaBreeze HelloWorld Application!", + "services": [ + { + "properties": { + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1 + }, + "name": "helloWorldService" + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + }, + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/myHelloWorldApp", + "name": "myHelloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json index aa925879e076..70d385aabeb3 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationDelete.json @@ -1,16 +1,16 @@ -{ - "operationId":"Application_Delete", - "description":"This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview", - "resourceGroupName": "sbz_demo", - "applicationName": "helloWorldAppWindows" - }, - "responses": { - "200": {}, - "204": {} - } - } - - +{ + "operationId":"Application_Delete", + "description":"This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "applicationName": "helloWorldAppWindows" + }, + "responses": { + "200": {}, + "204": {} + } + } + + diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json index fa3243b21b41..e7cb3ca44884 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationGet.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "demo1" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", - "name": "helloWorldAppWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "demo1" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json index 2d4e507408ef..77fad4690360 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsByResourceGroup.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", - "name": "helloWorldApp", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", - "name": "helloWorldAppWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json index c86d60e3f22b..1a8dc2267ca6 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ApplicationsBySubscriptionId.json @@ -1,175 +1,175 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappl", - "name": "myappl", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "healthState": "Ok", - "serviceNames": [ - "myservice" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappw", - "name": "myappw", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "healthState": "Ok", - "serviceNames": [ - "myservice" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", - "name": "SbzVoting", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Voting SeaBreeze!", - "healthState": "Ok", - "serviceNames": [ - "VotingWeb", - "VotingData" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", - "name": "SbzVoting", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Voting SeaBreeze!", - "healthState": "Ok", - "serviceNames": [ - "VotingWeb", - "VotingData" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", - "name": "helloWorldApp", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", - "name": "helloWorldAppWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "SeaBreeze HelloWorld Application!", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", - "name": "privateRegistryExampleApp", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "SeaBreeze example application with container deployed from private image registry.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Invalid" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", - "name": "SbzVoting", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Voting SeaBreeze!", - "healthState": "Ok", - "serviceNames": [ - "VotingWeb", - "VotingData" - ], - "status": "Ready" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", - "name": "privateRegistryExampleApp", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "SeaBreeze example application with container deployed from private image registry.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Invalid" - } - }, - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", - "name": "privateRegistryExampleApp", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "SeaBreeze example application with container deployed from private image registry.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Invalid" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappl", + "name": "myappl", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/abhisramvol/providers/Microsoft.ServiceFabricMesh/applications/myappw", + "name": "myappw", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "healthState": "Ok", + "serviceNames": [ + "myservice" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp2/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/mfussellapp3/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldApp", + "name": "helloWorldApp", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/helloWorldAppWindows", + "name": "helloWorldAppWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "SeaBreeze HelloWorld Application!", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar1ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridhar4ResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/SbzVoting", + "name": "SbzVoting", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Voting SeaBreeze!", + "healthState": "Ok", + "serviceNames": [ + "VotingWeb", + "VotingData" + ], + "status": "Ready" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharResourceGroup/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + }, + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sridharRG/providers/Microsoft.ServiceFabricMesh/applications/privateRegistryExampleApp", + "name": "privateRegistryExampleApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "SeaBreeze example application with container deployed from private image registry.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Invalid" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json index 4b7cc891243a..e016fecf2303 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ContainerLogsList.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "sbzDocApp", - "serviceName": "sbzDocService", - "replicaName": "0", - "codePackageName": "sbzDocCode" - }, - "responses": { - "200": { - "body": { - "content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "sbzDocApp", + "serviceName": "sbzDocService", + "replicaName": "0", + "codePackageName": "sbzDocCode" + }, + "responses": { + "200": { + "body": { + "content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n" + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json index 59aa09568838..6fb26b519568 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json @@ -1,76 +1,76 @@ -{ - "operationId": "Network_Create", - "description": "This example shows how to create a network resource with custom address range and a load balanced public endpoint.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "networkName": "helloWorldNetworkWindows", - "networkResourceDescription": { - "properties": { - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "layer4": [ - { - "publicPort": "80", - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - }, - "location": "eastus" - } - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", - "name": "helloWorldNetworkWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", - "name": "helloWorldNetworkWindows", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - } - } - } +{ + "operationId": "Network_Create", + "description": "This example shows how to create a network resource with custom address range and a load balanced public endpoint.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows", + "networkResourceDescription": { + "properties": { + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "layer4": [ + { + "publicPort": "80", + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json index 0eee1b214f41..f76cb79ee602 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkDelete.json @@ -1,14 +1,14 @@ -{ - "operationId":"Network_Delete", - "description":"This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview", - "resourceGroupName": "sbz_demo", - "networkName": "helloWorldNetworkWindows" - }, - "responses": { - "200": {}, - "204": {} - } -} +{ + "operationId":"Network_Delete", + "description":"This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json index 6ae8caf1e8d1..bc6ed0061f86 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworkGet.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "networkName": "helloWorldNetworkWindows" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", - "name": "helloWorldNetworkWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "publicIPAddress": "52.191.255.103", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "networkName": "helloWorldNetworkWindows" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json index 32d19f8454b5..47d92154ad44 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksByResourceGroup.json @@ -1,61 +1,61 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", - "name": "helloWorldNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "publicIPAddress": "52.191.12.219", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - }, - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", - "name": "helloWorldNetworkWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "publicIPAddress": "52.191.255.103", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json index 6527fdc04c6a..b1bf29402e9f 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/NetworksBySubscriptionId.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", - "name": "helloWorldNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "publicIPAddress": "52.191.12.219", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - }, - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", - "name": "helloWorldNetworkWindows", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "addressPrefix": "10.0.0.4/22", - "ingressConfig": { - "qosLevel": "Bronze", - "publicIPAddress": "52.191.255.103", - "layer4": [ - { - "publicPort": 80, - "applicationName": "helloWorldAppWindows", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - ] - } - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork", + "name": "helloWorldNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.12.219", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/{resourceGroup}/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetworkWindows", + "name": "helloWorldNetworkWindows", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.0.4/22", + "ingressConfig": { + "qosLevel": "Bronze", + "publicIPAddress": "52.191.255.103", + "layer4": [ + { + "publicPort": 80, + "applicationName": "helloWorldAppWindows", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + ] + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json index beb530b0fcf3..e6259087c844 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicaGet.json @@ -1,109 +1,109 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "replicaName": "1" - }, - "responses": { - "200": { - "body": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.9016844", - "lastTimestamp": "2018-04-06T06:36:06.0887046", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.6622454", - "lastTimestamp": "2018-04-06T06:34:00.6622454", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - }, - { - "name": "helloWorldSideCar", - "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.906688", - "lastTimestamp": "2018-04-06T06:36:06.0827003", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.656241", - "lastTimestamp": "2018-04-06T06:34:00.656241", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" - } - ], - "replicaName": "1" - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "replicaName": "1" + }, + "responses": { + "200": { + "body": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json index c7549c862176..49ddd753eff5 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ReplicasGetAll.json @@ -1,207 +1,207 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.9016844", - "lastTimestamp": "2018-04-06T06:36:06.0887046", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.6622454", - "lastTimestamp": "2018-04-06T06:34:00.6622454", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - }, - { - "name": "helloWorldSideCar", - "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.906688", - "lastTimestamp": "2018-04-06T06:36:06.0827003", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.656241", - "lastTimestamp": "2018-04-06T06:34:00.656241", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" - } - ], - "replicaName": "1" - }, - { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.9016844", - "lastTimestamp": "2018-04-06T06:36:06.0887046", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.6622454", - "lastTimestamp": "2018-04-06T06:34:00.6622454", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - }, - { - "name": "helloWorldSideCar", - "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - }, - "instanceView": { - "restartCount": 1, - "currentState": { - "state": "Running", - "exitCode": "0" - }, - "previousState": { - "state": "NotSpecified", - "exitCode": "0" - }, - "events": [ - { - "count": 3, - "firstTimestamp": "2018-04-05T22:37:20.906688", - "lastTimestamp": "2018-04-06T06:36:06.0827003", - "name": "Created", - "message": "Container created and started.", - "type": "Normal" - }, - { - "count": 1, - "firstTimestamp": "2018-04-06T06:34:00.656241", - "lastTimestamp": "2018-04-06T06:34:00.656241", - "name": "Stopped", - "message": "Container was stopped.", - "type": "Normal" - } - ] - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" - } - ], - "replicaName": "0" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "1" + }, + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.906688", + "lastTimestamp": "2018-04-06T06:36:06.0827003", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.656241", + "lastTimestamp": "2018-04-06T06:34:00.656241", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "replicaName": "0" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json index d5bfe5632f4b..10ddf3cfc5db 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceGet.json @@ -1,57 +1,57 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService" - }, - "responses": { - "200": { - "body": { - "name": "helloWorldService", - "type": "Microsoft.ServiceFabricMesh/services", - "properties": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - }, - { - "name": "helloWorldSideCar", - "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" - } - ], - "description": "SeaBreeze Hello World Service.", - "replicaCount": 2, - "healthState": "Ok", - "status": "Unknown" - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 2, + "healthState": "Ok", + "status": "Unknown" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json index cc2e90cc9e59..c8fbe35869fd 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/ServiceList.json @@ -1,62 +1,62 @@ -{ - "operationId":"Service_ListByApplicationName", - "description":"This example shows how to list all services of a given application.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "applicationName": "helloWorldApp" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "helloWorldService", - "type": "Microsoft.ServiceFabricMesh/services", - "properties": { - "osType": "Linux", - "codePackages": [ - { - "name": "helloWorldCode", - "image": "seabreeze/sbz-helloworld:1.0-alpine", - "endpoints": [ - { - "name": "helloWorldListener", - "port": 80 - } - ], - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - }, - { - "name": "helloWorldSideCar", - "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", - "resources": { - "requests": { - "memoryInGB": 1, - "cpu": 1 - } - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" - } - ], - "description": "SeaBreeze Hello World Service.", - "replicaCount": 1, - "healthState": "Ok", - "status": "Unknown" - } - } - ] - } - } - } +{ + "operationId":"Service_ListByApplicationName", + "description":"This example shows how to list all services of a given application.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "applicationName": "helloWorldApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + }, + { + "name": "helloWorldSideCar", + "image": "seabreeze/sbz-helloworld-sidecar:1.0-alpine", + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/helloWorldNetwork" + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Unknown" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json index 2d3c36f4c007..50326bbbee3a 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeCreate.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "volumeName": "sbzDemoVolume", - "volumeResourceDescription": { - "properties": { - "description": "File share backed by Azure Files storage.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "accountKey": "provide-account-key-here", - "shareName": "sharel" - }, - "provider": "SFAzureFile" - }, - "location": "eastus" - } - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", - "name": "sbzDemoVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", - "name": "sbzDemoVolume", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume", + "volumeResourceDescription": { + "properties": { + "description": "File share backed by Azure Files storage.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + }, + "provider": "SFAzureFile" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json index 02145e25ee18..8fcb4aa54144 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeDelete.json @@ -1,14 +1,14 @@ -{ - "operationId":"Volume_Delete", - "description":"This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview", - "resourceGroupName": "sbz_demo", - "volumeName": "sbzDemoVolume" - }, - "responses": { - "200": {}, - "204": {} - } -} +{ + "operationId":"Volume_Delete", + "description":"This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview", + "resourceGroupName": "sbz_demo", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json index 4a8cc7e3d626..def023970eb5 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumeGet.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview", - "volumeName": "sbzDemoVolume" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", - "name": "sbzDemoVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview", + "volumeName": "sbzDemoVolume" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json index 6c68786b1a06..39b4dca5f5ee 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesByResourceGroup.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume2", - "name": "sbzDemoShare", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - }, - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", - "name": "sbzDemoVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume2", + "name": "sbzDemoShare", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sbzDemoVolume", + "name": "sbzDemoVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json index 2afae5f97d1a..7d86747bed0e 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/examples/VolumesBySubscriptionId.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharel", - "name": "mysharel", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharel", - "accountName": "sbzdemoaccount" - } - } - }, - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "eastus", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharew", - "name": "mysharew", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "File share backed by Azure Files storage.", - "provider": "SFAzureFile", - "azureFileParameters": { - "shareName": "sharew", - "accountName": "sbzdemoaccount" - } - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharel", + "name": "mysharel", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharel", + "accountName": "sbzdemoaccount" + } + } + }, + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbzdemo/providers/Microsoft.ServiceFabricMesh/volumes/mysharew", + "name": "mysharew", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "File share backed by Azure Files storage.", + "provider": "SFAzureFile", + "azureFileParameters": { + "shareName": "sharew", + "accountName": "sbzdemoaccount" + } + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json index cd4b6488ca71..abe173b81466 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json @@ -1,2245 +1,2245 @@ -{ - "swagger": "2.0", - "info": { - "title": "SeaBreezeManagementClient", - "description": "APIs to deploy and manage resources to SeaBreeze.", - "version": "2018-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2" - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}": { - "put": { - "operationId": "Application_Create", - "x-ms-examples": { - "ApplicationCreateOrUpdate": { - "$ref": "./examples/ApplicationCreateOrUpdate.json" - } - }, - "summary": "Creates or updates an application resource.", - "description": "Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to provide public connectivity to the services of an application.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "get": { - "operationId": "Application_Get", - "x-ms-examples": { - "ApplicationGet": { - "$ref": "./examples/ApplicationGet.json" - } - }, - "summary": "Gets the application resource.", - "description": "Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Application_Delete", - "x-ms-examples": { - "ApplicationDelete": { - "$ref": "./examples/ApplicationDelete.json" - } - }, - "summary": "Deletes the application resource.", - "description": "Deletes the application resource identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content - the specified application was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services": { - "get": { - "operationId": "Service_ListByApplicationName", - "x-ms-examples": { - "ServiceGetAll": { - "$ref": "./examples/ServiceList.json" - } - }, - "summary": "Gets services of a given application.", - "description": "Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - } - ], - "tags": [ - "Services" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}": { - "get": { - "operationId": "Service_Get", - "x-ms-examples": { - "ServiceGet": { - "$ref": "./examples/ServiceGet.json" - } - }, - "summary": "Gets the properties of the service.", - "description": "The operation returns the properties of the service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceNameRequiredPathParam" - } - ], - "tags": [ - "Services" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResourceDescription" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas": { - "get": { - "operationId": "Replica_ListByServiceName", - "x-ms-examples": { - "ReplicasGetAll": { - "$ref": "./examples/ReplicasGetAll.json" - } - }, - "summary": "Gets replicas of a given service.", - "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceNameRequiredPathParam" - } - ], - "tags": [ - "Replicas" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceReplicaList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}": { - "get": { - "operationId": "Replica_Get", - "x-ms-examples": { - "ReplicaGet": { - "$ref": "./examples/ReplicaGet.json" - } - }, - "summary": "Gets a specific replica of a given service.", - "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaNameRequiredPathParam" - } - ], - "tags": [ - "Replicas" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceReplicaDescription" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications": { - "get": { - "operationId": "Application_ListByResourceGroup", - "x-ms-examples": { - "ApplicationList": { - "$ref": "./examples/ApplicationsByResourceGroup.json" - } - }, - "summary": "Gets all the application resources in a given resource group.", - "description": "Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications": { - "get": { - "operationId": "Application_ListBySubscription", - "x-ms-examples": { - "ApplicationList": { - "$ref": "./examples/ApplicationsBySubscriptionId.json" - } - }, - "summary": "Gets all the application resources in a given subscription.", - "description": "Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { - "get": { - "operationId": "CodePackage_GetContainerLog", - "x-ms-examples": { - "ContainerLogsList": { - "$ref": "./examples/ContainerLogsList.json" - } - }, - "summary": "Gets the logs for the container.", - "description": "Get the logs for the container of a given code package of an application.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaNameRequiredPathParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TailOptionalQueryParam" - } - ], - "tags": [ - "ContainerLogs" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/ContainerLogs" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/providers/Microsoft.ServiceFabricMesh/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "Lists all of the available operations.", - "description": "Lists all the available operations provided by Service Fabric SeaBreeze resource provider.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}": { - "put": { - "operationId": "Network_Create", - "x-ms-examples": { - "Network_Create": { - "$ref": "./examples/NetworkCreateOrUpdate.json" - } - }, - "summary": "Creates or updates a network resource.", - "description": "Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to create private network and configure public connectivity for services within your application. \n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "get": { - "operationId": "Network_Get", - "x-ms-examples": { - "NetworkGet": { - "$ref": "./examples/NetworkGet.json" - } - }, - "summary": "Gets the network resource.", - "description": "Gets the information about the network resource with a given name. This information includes the network description and other runtime information.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkNameRequiredPathParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Network_Delete", - "x-ms-examples": { - "NetworkDelete": { - "$ref": "./examples/NetworkDelete.json" - } - }, - "summary": "Deletes the network resource.", - "description": "Deletes the network resource identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkNameRequiredPathParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content - the specified network was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks": { - "get": { - "operationId": "Network_ListByResourceGroup", - "x-ms-examples": { - "NetworksList": { - "$ref": "./examples/NetworksByResourceGroup.json" - } - }, - "summary": "Gets all the network resources in a given resource group.", - "description": "Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks": { - "get": { - "operationId": "Network_ListBySubscription", - "x-ms-examples": { - "NetworksList": { - "$ref": "./examples/NetworksBySubscriptionId.json" - } - }, - "summary": "Gets all the network resources in a given subscription.", - "description": "Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}": { - "put": { - "operationId": "Volume_Create", - "x-ms-examples": { - "VolumeCreate": { - "$ref": "./examples/VolumeCreate.json" - } - }, - "summary": "Creates or updates a volume resource.", - "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "get": { - "operationId": "Volume_Get", - "x-ms-examples": { - "VolumeGet": { - "$ref": "./examples/VolumeGet.json" - } - }, - "summary": "Gets the volume resource.", - "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeNameRequiredPathParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Volume_Delete", - "x-ms-examples": { - "VolumeDelete": { - "$ref": "./examples/VolumeDelete.json" - } - }, - "summary": "Deletes the volume resource.", - "description": "Deletes the volume identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeNameRequiredPathParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content - the specified volume was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes": { - "get": { - "operationId": "Volume_ListByResourceGroup", - "x-ms-examples": { - "VolumesList": { - "$ref": "./examples/VolumesByResourceGroup.json" - } - }, - "summary": "Gets all the volume resources in a given resource group.", - "description": "Gets the information about all volume resources in a given resource group. The information includes the volume description and other runtime information.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes": { - "get": { - "operationId": "Volume_ListBySubscription", - "x-ms-examples": { - "VolumesList": { - "$ref": "./examples/VolumesBySubscriptionId.json" - } - }, - "summary": "Gets all the volume resources in a given subscription.", - "description": "Gets the information about all volume resources in a given subscription. The information includes the volume description and other runtime information.\n", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Resource": { - "description": "The resource model definition for Azure Resource Manager resource.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource", - "x-ms-mutability": [ - "read" - ] - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", - "x-ms-mutability": [ - "read" - ] - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The geo-location where the resource lives" - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ManagedProxyResource": { - "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", - "x-ms-mutability": [ - "read" - ] - }, - "name": { - "type": "string", - "description": "The name of the resource", - "x-ms-mutability": [ - "read", - "create", - "update" - ] - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", - "x-ms-mutability": [ - "read" - ] - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for Azure Resource Manager tracked top-level resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The geo-location where the resource lives" - } - }, - "required": [ - "location" - ] - }, - "ProvisionedResourceProperties": { - "description": "Describes common properties of a provisioned resource.", - "properties": { - "provisioningState": { - "type": "string", - "description": "State of the resource.", - "readOnly": true - } - } - }, - "NetworkResourceDescriptionList": { - "description": "A pageable list of network resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "NetworkResourceDescription": { - "description": "This type describes a network resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NetworkResourceProperties", - "description": "Describes properties of a network resource." - } - }, - "required": [ - "properties" - ] - }, - "NetworkResourceProperties": { - "description": "Describes properties of a network resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/NetworkProperties" - } - ] - }, - "NetworkProperties": { - "description": "Describes a network.", - "type": "object", - "properties": { - "description": { - "description": "User readable description of the network.", - "type": "string" - }, - "addressPrefix": { - "description": "the address prefix for this network.", - "type": "string" - }, - "ingressConfig": { - "$ref": "#/definitions/IngressConfig", - "description": "Configuration for public connectivity for this network." - } - }, - "required": [ - "addressPrefix" - ] - }, - "VolumeResourceDescriptionList": { - "description": "A pageable list of volume resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VolumeResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "VolumeResourceDescription": { - "description": "This type describes a volume resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VolumeResourceProperties", - "description": "Describes properties of a volume resource." - } - }, - "required": [ - "properties" - ] - }, - "VolumeResourceProperties": { - "description": "Describes properties of a volume resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/VolumeProperties" - } - ] - }, - "VolumeProperties": { - "description": "This type describes properties of a volume resource.", - "type": "object", - "properties": { - "description": { - "description": "User readable description of the volume.", - "type": "string" - }, - "provider": { - "description": "Provider of the volume.", - "type": "string", - "enum": [ - "SFAzureFile" - ], - "x-ms-enum": { - "name": "VolumeProvider", - "modelAsString": true - } - }, - "azureFileParameters": { - "$ref": "#/definitions/VolumeProviderParametersAzureFile", - "description": "This type describes a volume provided by an Azure Files file share." - } - }, - "required": [ - "provider" - ] - }, - "VolumeProviderParametersAzureFile": { - "description": "This type describes a volume provided by an Azure Files file share.", - "type": "object", - "properties": { - "accountName": { - "description": "Name of the Azure storage account for the File Share.", - "type": "string" - }, - "accountKey": { - "description": "Access key of the Azure storage account for the File Share.", - "type": "string" - }, - "shareName": { - "description": "Name of the Azure Files file share that provides storage for the volume.", - "type": "string" - } - }, - "required": [ - "accountName", - "shareName" - ] - }, - "ApplicationResourceDescriptionList": { - "description": "A pageable list of application resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "ApplicationResourceDescription": { - "description": "This type describes an application resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationResourceProperties", - "description": "This type describes properties of an application resource." - } - }, - "required": [ - "properties" - ] - }, - "ApplicationResourceProperties": { - "description": "This type describes properties of an application resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/ApplicationProperties" - } - ] - }, - "ApplicationProperties": { - "description": "This type describes properties of an application resource.", - "type": "object", - "properties": { - "description": { - "description": "User readable description of the application.", - "type": "string" - }, - "debugParams": { - "description": "Internal use.", - "type": "string" - }, - "services": { - "type": "array", - "description": "describes the services in the application.", - "items": { - "$ref": "#/definitions/ServiceResourceDescription" - } - }, - "healthState": { - "readOnly": true, - "$ref": "#/definitions/HealthState", - "description": "Describes the health state of an application resource." - }, - "unhealthyEvaluation": { - "readOnly": true, - "type": "string", - "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Status of the application resource.", - "enum": [ - "Invalid", - "Ready", - "Upgrading", - "Creating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ApplicationResourceStatus", - "modelAsString": true - } - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the application deployment." - }, - "serviceNames": { - "readOnly": true, - "description": "Names of the services in the application.", - "type": "array", - "items": { - "type": "string" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsDescription", - "description": "Describes the diagnostics definition and usage for an application resource." - } - } - }, - "ServiceList": { - "description": "A pageable list of all services in an application.\n", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "ServiceResourceDescription": { - "description": "This type describes a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ManagedProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServiceResourceProperties", - "description": "This type describes properties of a service resource." - } - }, - "required": [ - "properties" - ] - }, - "ServiceResourceProperties": { - "description": "This type describes properties of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceReplicaProperties" - }, - { - "type": "object", - "properties": { - "description": { - "description": "User readable description of the service.", - "type": "string" - }, - "replicaCount": { - "type": "integer", - "description": "The number of replicas of the service to create. Defaults to 1 if not specified." - }, - "healthState": { - "$ref": "#/definitions/HealthState", - "description": "The health state of a resource such as Application, Service, or Network." - }, - "status": { - "readOnly": true, - "type": "string", - "description": "Represents the status of the service.", - "enum": [ - "Unknown", - "Active", - "Upgrading", - "Deleting", - "Creating", - "Failed" - ], - "x-ms-enum": { - "name": "ServiceResourceStatus", - "modelAsString": true - } - } - } - } - ] - }, - "ContainerInstanceView": { - "description": "Runtime information of a container instance.", - "type": "object", - "properties": { - "restartCount": { - "type": "integer", - "description": "The number of times the container has been restarted." - }, - "currentState": { - "$ref": "#/definitions/ContainerState", - "description": "Current container instance state." - }, - "previousState": { - "$ref": "#/definitions/ContainerState", - "description": "Previous container instance state." - }, - "events": { - "description": "The events of this container instance.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerEvent" - } - } - } - }, - "ContainerEvent": { - "description": "A container event.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the container event." - }, - "count": { - "type": "integer", - "description": "The count of the event." - }, - "firstTimestamp": { - "type": "string", - "description": "Date/time of the first event." - }, - "lastTimestamp": { - "type": "string", - "description": "Date/time of the last event." - }, - "message": { - "type": "string", - "description": "The event message" - }, - "type": { - "type": "string", - "description": "The event type." - } - } - }, - "ContainerLabel": { - "description": "Describes a container label.", - "type": "object", - "properties": { - "name": { - "description": "The name of the container label.", - "type": "string" - }, - "value": { - "description": "The value of the container label.", - "type": "string" - } - }, - "required": [ - "name", - "value" - ] - }, - "ContainerLogs": { - "description": "The logs of the container.", - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "content of the log." - } - } - }, - "ContainerState": { - "description": "The container state.", - "type": "object", - "properties": { - "state": { - "type": "string", - "description": "The state of this container" - }, - "startTime": { - "type": "string", - "format": "date-time", - "description": "Date/time when the container state started." - }, - "exitCode": { - "type": "string", - "description": "The container exit code." - }, - "finishTime": { - "type": "string", - "format": "date-time", - "description": "Date/time when the container state finished." - }, - "detailStatus": { - "description": "Human-readable status of this state.", - "type": "string" - } - } - }, - "ImageRegistryCredential": { - "description": "Image registry credential.", - "type": "object", - "properties": { - "server": { - "type": "string", - "description": "Docker image registry server, without protocol such as `http` and `https`." - }, - "username": { - "type": "string", - "description": "The username for the private registry." - }, - "password": { - "type": "string", - "description": "The password for the private registry." - } - }, - "required": [ - "server", - "username" - ] - }, - "ResourceLimits": { - "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", - "type": "object", - "properties": { - "memoryInGB": { - "description": "The memory limit in GB.", - "type": "number", - "format": "double" - }, - "cpu": { - "description": "CPU limits in cores. At present, only full cores are supported.", - "type": "number", - "format": "double" - } - } - }, - "ResourceRequests": { - "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.\n", - "type": "object", - "properties": { - "memoryInGB": { - "description": "The memory request in GB for this container.", - "type": "number", - "format": "double" - }, - "cpu": { - "description": "Requested number of CPU cores. At present, only full cores are supported.", - "type": "number", - "format": "double" - } - }, - "required": [ - "memoryInGB", - "cpu" - ] - }, - "ResourceRequirements": { - "description": "This type describes the resource requirements for a container or a service.", - "type": "object", - "properties": { - "requests": { - "$ref": "#/definitions/ResourceRequests", - "description": "Describes the requested resources for a given container." - }, - "limits": { - "$ref": "#/definitions/ResourceLimits", - "description": "Describes the maximum limits on the resources for a given container." - } - }, - "required": [ - "requests" - ] - }, - "OperationListResult": { - "properties": { - "value": { - "type": "array", - "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", - "items": { - "$ref": "#/definitions/OperationResult" - } - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - }, - "description": "Describes the result of the request to list Service Fabric operations." - }, - "OperationResult": { - "properties": { - "name": { - "type": "string", - "description": "The name of the operation." - }, - "display": { - "$ref": "#/definitions/AvailableOperationDisplay", - "description": "The object that represents the operation." - }, - "origin": { - "type": "string", - "description": "Origin result" - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "List of operations available at the listed Azure resource provider." - }, - "AvailableOperationDisplay": { - "properties": { - "provider": { - "type": "string", - "description": "Name of the operation provider." - }, - "resource": { - "type": "string", - "description": "Name of the resource on which the operation is available." - }, - "operation": { - "type": "string", - "description": "Name of the available operation." - }, - "description": { - "type": "string", - "description": "Description of the available operation." - } - }, - "description": "An operation available at the listed Azure resource provider." - }, - "ErrorModel": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "The error details." - }, - "ContainerCodePackageProperties": { - "description": "Describes a container and its runtime properties.", - "type": "object", - "properties": { - "name": { - "description": "The name of the code package.", - "type": "string" - }, - "image": { - "description": "The Container image to use.", - "type": "string" - }, - "imageRegistryCredential": { - "$ref": "#/definitions/ImageRegistryCredential", - "description": "Image registry credential." - }, - "entrypoint": { - "description": "Override for the default entry point in the container.", - "type": "string" - }, - "commands": { - "description": "Command array to execute within the container in exec form.", - "type": "array", - "items": { - "type": "string" - } - }, - "environmentVariables": { - "description": "The environment variables to set in this container", - "type": "array", - "items": { - "$ref": "#/definitions/EnvironmentVariable" - } - }, - "settings": { - "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", - "type": "array", - "items": { - "$ref": "#/definitions/Setting" - } - }, - "labels": { - "description": "The labels to set in this container.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerLabel" - } - }, - "endpoints": { - "description": "The endpoints exposed by this container.", - "type": "array", - "items": { - "$ref": "#/definitions/EndpointProperties" - } - }, - "resources": { - "$ref": "#/definitions/ResourceRequirements", - "description": "This type describes the resource requirements for a container or a service." - }, - "volumeRefs": { - "description": "The volumes to be attached to the container.", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerVolume" - } - }, - "instanceView": { - "readOnly": true, - "$ref": "#/definitions/ContainerInstanceView", - "description": "Runtime information of a container instance." - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsRef", - "description": "Reference to sinks in DiagnosticsDescription." - } - }, - "required": [ - "name", - "image", - "resources" - ] - }, - "ContainerVolume": { - "description": "Describes how a volume is attached to a container.", - "type": "object", - "properties": { - "name": { - "description": "Name of the volume.", - "type": "string" - }, - "readOnly": { - "description": "The flag indicating whether the volume is read only. Default is 'false'.", - "type": "boolean" - }, - "destinationPath": { - "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", - "type": "string" - } - }, - "required": [ - "name", - "destinationPath" - ] - }, - "EndpointProperties": { - "description": "Describes a container endpoint.", - "type": "object", - "properties": { - "name": { - "description": "The name of the endpoint.", - "type": "string" - }, - "port": { - "description": "Port used by the container.", - "type": "integer" - } - }, - "required": [ - "name" - ] - }, - "ServiceReplicaList": { - "description": "A pageable list of replicas of a service resource.\n", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceReplicaDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "ServiceReplicaDescription": { - "type": "object", - "description": "This type describes a replica of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceReplicaProperties" - }, - { - "type": "object", - "properties": { - "replicaName": { - "type": "string", - "description": "Name of the replica." - } - } - } - ] - }, - "ServiceReplicaProperties": { - "description": "Describes the properties of a service replica.", - "type": "object", - "properties": { - "osType": { - "type": "string", - "description": "The Operating system type required by the code in service.\n", - "enum": [ - "Linux", - "Windows" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": true - } - }, - "codePackages": { - "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).\n", - "type": "array", - "items": { - "$ref": "#/definitions/ContainerCodePackageProperties" - } - }, - "networkRefs": { - "type": "array", - "description": "The names of the private networks that this service needs to be part of.", - "items": { - "$ref": "#/definitions/NetworkRef" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsRef", - "description": "Reference to sinks in DiagnosticsDescription." - } - }, - "required": [ - "osType", - "codePackages" - ] - }, - "IngressConfig": { - "description": "Describes public connectivity configuration for the network.", - "type": "object", - "properties": { - "qosLevel": { - "type": "string", - "description": "The QoS tier for ingress.", - "enum": [ - "Bronze" - ], - "x-ms-enum": { - "name": "IngressQoSLevel", - "modelAsString": true - } - }, - "layer4": { - "description": "Configuration for layer4 public connectivity for this network.", - "type": "array", - "items": { - "$ref": "#/definitions/Layer4IngressConfig" - } - }, - "publicIPAddress": { - "type": "string", - "readOnly": true, - "description": "The public IP address for reaching this network." - } - } - }, - "Layer4IngressConfig": { - "description": "Describes the layer4 configuration for public connectivity for this network.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Layer4 ingress config name." - }, - "publicPort": { - "type": "integer", - "description": "Specifies the public port at which the service endpoint below needs to be exposed." - }, - "applicationName": { - "type": "string", - "description": "The application name which contains the service to be exposed." - }, - "serviceName": { - "type": "string", - "description": "The service whose endpoint needs to be exposed at the public port." - }, - "endpointName": { - "type": "string", - "description": "The service endpoint that needs to be exposed." - } - } - }, - "EnvironmentVariable": { - "description": "Describes an environment variable for the container.", - "type": "object", - "properties": { - "name": { - "description": "The name of the environment variable.", - "type": "string" - }, - "value": { - "description": "The value of the environment variable.", - "type": "string" - } - } - }, - "Setting": { - "description": "Describes a setting for the container.", - "type": "object", - "properties": { - "name": { - "description": "The name of the setting.", - "type": "string" - }, - "value": { - "description": "The value of the setting.", - "type": "string" - } - } - }, - "NetworkRef": { - "description": "Describes a network reference in a service.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the network." - } - } - }, - "HealthState": { - "type": "string", - "description": "The health state of a resource such as Application, Service, or Network.", - "enum": [ - "Invalid", - "Ok", - "Warning", - "Error", - "Unknown" - ], - "x-ms-enum": { - "name": "HealthState", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." - }, - { - "value": "Ok", - "description": "Indicates the health state is okay. The value is 1." - }, - { - "value": "Warning", - "description": "Indicates the health state is at a warning level. The value is 2." - }, - { - "value": "Error", - "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." - }, - { - "value": "Unknown", - "description": "Indicates an unknown health status. The value is 65535." - } - ] - } - }, - "DiagnosticsDescription": { - "description": "Describes the diagnostics options available", - "type": "object", - "properties": { - "sinks": { - "description": "List of supported sinks that can be referenced.", - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticsSinkProperties" - } - }, - "enabled": { - "description": "Status of whether or not sinks are enabled.", - "type": "boolean" - }, - "defaultSinkRefs": { - "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DiagnosticsRef": { - "description": "Reference to sinks in DiagnosticsDescription.", - "type": "object", - "properties": { - "enabled": { - "description": "Status of whether or not sinks are enabled.", - "type": "boolean" - }, - "sinkRefs": { - "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DiagnosticsSinkProperties": { - "description": "Properties of a DiagnosticsSink.", - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/DiagnosticsSinkKind", - "description": "The kind of DiagnosticsSink." - }, - "name": { - "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", - "type": "string" - }, - "description": { - "description": "A description of the sink.", - "type": "string" - } - }, - "required": [ - "kind" - ] - }, - "DiagnosticsSinkKind": { - "type": "string", - "description": "The kind of DiagnosticsSink.", - "enum": [ - "Invalid", - "AzureInternalMonitoringPipeline" - ], - "x-ms-enum": { - "name": "DiagnosticsSinkKind", - "modelAsString": true, - "values": [ - { - "value": "Invalid", - "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." - }, - { - "value": "AzureInternalMonitoringPipeline", - "description": "Diagnostics settings for Geneva." - } - ] - } - }, - "AzureInternalMonitoringPipelineSinkDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/DiagnosticsSinkProperties" - } - ], - "x-ms-discriminator-value": "AzureInternalMonitoringPipeline", - "description": "Diagnostics settings for Geneva.", - "properties": { - "accountName": { - "description": "Azure Internal monitoring pipeline account.", - "type": "string" - }, - "namespace": { - "description": "Azure Internal monitoring pipeline account namespace.", - "type": "string" - }, - "maConfigUrl": { - "description": "Azure Internal monitoring agent configuration.", - "type": "string" - }, - "fluentdConfigUrl": { - "description": "Azure Internal monitoring agent fluentd configuration." - }, - "autoKeyConfigUrl": { - "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", - "type": "string" - } - } - } - }, - "parameters": { - "api-versionRequiredQueryParam": { - "name": "api-version", - "in": "query", - "type": "string", - "enum": [ - "2018-07-01-preview" - ], - "default": "2018-07-01-preview", - "description": "The version of the API. This parameter is required and its value must be `2018-07-01-preview`.", - "required": true, - "x-ms-enum": { - "name": "2018-07-01-preview", - "modelAsString": true, - "values": [ - { - "value": "2018-07-01-preview", - "description": "The `2018-07-01-preview` version of the API." - } - ] - } - }, - "subscriptionIdRequiredPathParam": { - "name": "subscriptionId", - "in": "path", - "description": "The customer subscription identifier", - "required": true, - "type": "string" - }, - "ResourceGroupNameRequiredPathParam": { - "name": "resourceGroupName", - "in": "path", - "description": "Azure resource group name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ApplicationNameRequiredPathParam": { - "name": "applicationName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the application." - }, - "ApplicationResourceDescriptionRequiredBodyParam": { - "name": "applicationResourceDescription", - "in": "body", - "description": "Description for creating an application resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "ServiceNameRequiredPathParam": { - "name": "serviceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the service." - }, - "ReplicaNameRequiredPathParam": { - "name": "replicaName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the service replica." - }, - "NetworkNameRequiredPathParam": { - "name": "networkName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the network." - }, - "NetworkResourceDescriptionRequiredBodyParam": { - "name": "networkResourceDescription", - "in": "body", - "description": "Description for creating a network resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "VolumeNameRequiredPathParam": { - "name": "volumeName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the volume." - }, - "VolumeResourceDescriptionRequiredBodyParam": { - "name": "volumeResourceDescription", - "in": "body", - "description": "Description for creating a volume resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "CodePackageNameRequiredPathParam": { - "name": "codePackageName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The name of the code package." - }, - "TailOptionalQueryParam": { - "name": "tail", - "in": "query", - "x-ms-parameter-location": "method", - "type": "integer", - "required": false, - "description": "Number of lines to show from the end of the logs. Default is 100." - } - } +{ + "swagger": "2.0", + "info": { + "title": "SeaBreezeManagementClient", + "description": "APIs to deploy and manage resources to SeaBreeze.", + "version": "2018-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}": { + "put": { + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreateOrUpdate": { + "$ref": "./examples/ApplicationCreateOrUpdate.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application resource with the specified name and description. If an application with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to provide public connectivity to the services of an application.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "summary": "Gets the application resource.", + "description": "Gets the information about the application resource with a given name. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + }, + "summary": "Deletes the application resource.", + "description": "Deletes the application resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services": { + "get": { + "operationId": "Service_ListByApplicationName", + "x-ms-examples": { + "ServiceGetAll": { + "$ref": "./examples/ServiceList.json" + } + }, + "summary": "Gets services of a given application.", + "description": "Gets the information about all services of a given service of an application. The information includes the runtime properties of the service instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}": { + "get": { + "operationId": "Service_Get", + "x-ms-examples": { + "ServiceGet": { + "$ref": "./examples/ServiceGet.json" + } + }, + "summary": "Gets the properties of the service.", + "description": "The operation returns the properties of the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas": { + "get": { + "operationId": "Replica_ListByServiceName", + "x-ms-examples": { + "ReplicasGetAll": { + "$ref": "./examples/ReplicasGetAll.json" + } + }, + "summary": "Gets replicas of a given service.", + "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}": { + "get": { + "operationId": "Replica_Get", + "x-ms-examples": { + "ReplicaGet": { + "$ref": "./examples/ReplicaGet.json" + } + }, + "summary": "Gets a specific replica of a given service.", + "description": "Gets the information about the specified replica of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "Replicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListByResourceGroup", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsByResourceGroup.json" + } + }, + "summary": "Gets all the application resources in a given resource group.", + "description": "Gets the information about all application resources in a given resource group. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListBySubscription", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationsBySubscriptionId.json" + } + }, + "summary": "Gets all the application resources in a given subscription.", + "description": "Gets the information about all application resources in a given subscription. The information includes the information about the application's services and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationName}/services/{serviceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { + "get": { + "operationId": "CodePackage_GetContainerLog", + "x-ms-examples": { + "ContainerLogsList": { + "$ref": "./examples/ContainerLogsList.json" + } + }, + "summary": "Gets the logs for the container.", + "description": "Get the logs for the container of a given code package of an application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "ContainerLogs" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabricMesh/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available operations.", + "description": "Lists all the available operations provided by Service Fabric SeaBreeze resource provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}": { + "put": { + "operationId": "Network_Create", + "x-ms-examples": { + "Network_Create": { + "$ref": "./examples/NetworkCreateOrUpdate.json" + } + }, + "summary": "Creates or updates a network resource.", + "description": "Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.\n\nUse network resources to create private network and configure public connectivity for services within your application. \n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Network_Get", + "x-ms-examples": { + "NetworkGet": { + "$ref": "./examples/NetworkGet.json" + } + }, + "summary": "Gets the network resource.", + "description": "Gets the information about the network resource with a given name. This information includes the network description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Network_Delete", + "x-ms-examples": { + "NetworkDelete": { + "$ref": "./examples/NetworkDelete.json" + } + }, + "summary": "Deletes the network resource.", + "description": "Deletes the network resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified network was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListByResourceGroup", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksByResourceGroup.json" + } + }, + "summary": "Gets all the network resources in a given resource group.", + "description": "Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListBySubscription", + "x-ms-examples": { + "NetworksList": { + "$ref": "./examples/NetworksBySubscriptionId.json" + } + }, + "summary": "Gets all the network resources in a given subscription.", + "description": "Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}": { + "put": { + "operationId": "Volume_Create", + "x-ms-examples": { + "VolumeCreate": { + "$ref": "./examples/VolumeCreate.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name and description. If a volume with the same name already exists, then its description is updated to the one indicated in this request.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "get": { + "operationId": "Volume_Get", + "x-ms-examples": { + "VolumeGet": { + "$ref": "./examples/VolumeGet.json" + } + }, + "summary": "Gets the volume resource.", + "description": "Gets the information about the volume resource with a given name. This information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Volume_Delete", + "x-ms-examples": { + "VolumeDelete": { + "$ref": "./examples/VolumeDelete.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListByResourceGroup", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesByResourceGroup.json" + } + }, + "summary": "Gets all the volume resources in a given resource group.", + "description": "Gets the information about all volume resources in a given resource group. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListBySubscription", + "x-ms-examples": { + "VolumesList": { + "$ref": "./examples/VolumesBySubscriptionId.json" + } + }, + "summary": "Gets all the volume resources in a given subscription.", + "description": "Gets the information about all volume resources in a given subscription. The information includes the volume description and other runtime information.\n", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "The resource model definition for Azure Resource Manager resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ManagedProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for Azure Resource Manager tracked top-level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ] + }, + "ProvisionedResourceProperties": { + "description": "Describes common properties of a provisioned resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "State of the resource.", + "readOnly": true + } + } + }, + "NetworkResourceDescriptionList": { + "description": "A pageable list of network resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "properties" + ] + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/NetworkProperties" + } + ] + }, + "NetworkProperties": { + "description": "Describes a network.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the network.", + "type": "string" + }, + "addressPrefix": { + "description": "the address prefix for this network.", + "type": "string" + }, + "ingressConfig": { + "$ref": "#/definitions/IngressConfig", + "description": "Configuration for public connectivity for this network." + } + }, + "required": [ + "addressPrefix" + ] + }, + "VolumeResourceDescriptionList": { + "description": "A pageable list of volume resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeResourceProperties", + "description": "Describes properties of a volume resource." + } + }, + "required": [ + "properties" + ] + }, + "VolumeResourceProperties": { + "description": "Describes properties of a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/VolumeProperties" + } + ] + }, + "VolumeProperties": { + "description": "This type describes properties of a volume resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the volume.", + "type": "string" + }, + "provider": { + "description": "Provider of the volume.", + "type": "string", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true + } + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "type": "object", + "properties": { + "accountName": { + "description": "Name of the Azure storage account for the File Share.", + "type": "string" + }, + "accountKey": { + "description": "Access key of the Azure storage account for the File Share.", + "type": "string" + }, + "shareName": { + "description": "Name of the Azure Files file share that provides storage for the volume.", + "type": "string" + } + }, + "required": [ + "accountName", + "shareName" + ] + }, + "ApplicationResourceDescriptionList": { + "description": "A pageable list of application resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ApplicationResourceDescription": { + "description": "This type describes an application resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "properties" + ] + }, + "ApplicationResourceProperties": { + "description": "This type describes properties of an application resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ApplicationProperties" + } + ] + }, + "ApplicationProperties": { + "description": "This type describes properties of an application resource.", + "type": "object", + "properties": { + "description": { + "description": "User readable description of the application.", + "type": "string" + }, + "debugParams": { + "description": "Internal use.", + "type": "string" + }, + "services": { + "type": "array", + "description": "describes the services in the application.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Status of the application resource.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationResourceStatus", + "modelAsString": true + } + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application deployment." + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + } + } + }, + "ServiceList": { + "description": "A pageable list of all services in an application.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceResourceDescription": { + "description": "This type describes a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "description": { + "description": "User readable description of the service.", + "type": "string" + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "healthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a resource such as Application, Service, or Network." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Represents the status of the service.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceResourceStatus", + "modelAsString": true + } + } + } + } + ] + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "type": "object", + "properties": { + "restartCount": { + "type": "integer", + "description": "The number of times the container has been restarted." + }, + "currentState": { + "$ref": "#/definitions/ContainerState", + "description": "Current container instance state." + }, + "previousState": { + "$ref": "#/definitions/ContainerState", + "description": "Previous container instance state." + }, + "events": { + "description": "The events of this container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerEvent" + } + } + } + }, + "ContainerEvent": { + "description": "A container event.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the container event." + }, + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "description": "Date/time of the first event." + }, + "lastTimestamp": { + "type": "string", + "description": "Date/time of the last event." + }, + "message": { + "type": "string", + "description": "The event message" + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "type": "object", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerLogs": { + "description": "The logs of the container.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "content of the log." + } + } + }, + "ContainerState": { + "description": "The container state.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of this container" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state started." + }, + "exitCode": { + "type": "string", + "description": "The container exit code." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state finished." + }, + "detailStatus": { + "description": "Human-readable status of this state.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "ResourceLimits": { + "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "CPU limits in cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + } + }, + "ResourceRequests": { + "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.\n", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory request in GB for this container.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "Requested number of CPU cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + }, + "required": [ + "memoryInGB", + "cpu" + ] + }, + "ResourceRequirements": { + "description": "This type describes the resource requirements for a container or a service.", + "type": "object", + "properties": { + "requests": { + "$ref": "#/definitions/ResourceRequests", + "description": "Describes the requested resources for a given container." + }, + "limits": { + "$ref": "#/definitions/ResourceLimits", + "description": "Describes the maximum limits on the resources for a given container." + } + }, + "required": [ + "requests" + ] + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of operations available at the listed Azure resource provider." + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "Name of the operation provider." + }, + "resource": { + "type": "string", + "description": "Name of the resource on which the operation is available." + }, + "operation": { + "type": "string", + "description": "Name of the available operation." + }, + "description": { + "type": "string", + "description": "Description of the available operation." + } + }, + "description": "An operation available at the listed Azure resource provider." + }, + "ErrorModel": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the code package.", + "type": "string" + }, + "image": { + "description": "The Container image to use.", + "type": "string" + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Image registry credential." + }, + "entrypoint": { + "description": "Override for the default entry point in the container.", + "type": "string" + }, + "commands": { + "description": "Command array to execute within the container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in this container", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "settings": { + "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "labels": { + "description": "The labels to set in this container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + "endpoints": { + "description": "The endpoints exposed by this container.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "resources": { + "$ref": "#/definitions/ResourceRequirements", + "description": "This type describes the resource requirements for a container or a service." + }, + "volumeRefs": { + "description": "The volumes to be attached to the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerVolume" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerVolume": { + "description": "Describes how a volume is attached to a container.", + "type": "object", + "properties": { + "name": { + "description": "Name of the volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume is read only. Default is 'false'.", + "type": "boolean" + }, + "destinationPath": { + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed.", + "type": "string" + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "ServiceReplicaList": { + "description": "A pageable list of replicas of a service resource.\n", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceReplicaDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceReplicaDescription": { + "type": "object", + "description": "This type describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "type": "object", + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + } + } + ] + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "type": "object", + "properties": { + "osType": { + "type": "string", + "description": "The Operating system type required by the code in service.\n", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "codePackages": { + "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).\n", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + "networkRefs": { + "type": "array", + "description": "The names of the private networks that this service needs to be part of.", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "osType", + "codePackages" + ] + }, + "IngressConfig": { + "description": "Describes public connectivity configuration for the network.", + "type": "object", + "properties": { + "qosLevel": { + "type": "string", + "description": "The QoS tier for ingress.", + "enum": [ + "Bronze" + ], + "x-ms-enum": { + "name": "IngressQoSLevel", + "modelAsString": true + } + }, + "layer4": { + "description": "Configuration for layer4 public connectivity for this network.", + "type": "array", + "items": { + "$ref": "#/definitions/Layer4IngressConfig" + } + }, + "publicIPAddress": { + "type": "string", + "readOnly": true, + "description": "The public IP address for reaching this network." + } + } + }, + "Layer4IngressConfig": { + "description": "Describes the layer4 configuration for public connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Layer4 ingress config name." + }, + "publicPort": { + "type": "integer", + "description": "Specifies the public port at which the service endpoint below needs to be exposed." + }, + "applicationName": { + "type": "string", + "description": "The application name which contains the service to be exposed." + }, + "serviceName": { + "type": "string", + "description": "The service whose endpoint needs to be exposed at the public port." + }, + "endpointName": { + "type": "string", + "description": "The service endpoint that needs to be exposed." + } + } + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "Setting": { + "description": "Describes a setting for the container.", + "type": "object", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the network." + } + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a resource such as Application, Service, or Network.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "type": "object", + "properties": { + "sinks": { + "description": "List of supported sinks that can be referenced.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "defaultSinkRefs": { + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsRef": { + "description": "Reference to sinks in DiagnosticsDescription.", + "type": "object", + "properties": { + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "sinkRefs": { + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/DiagnosticsSinkKind", + "description": "The kind of DiagnosticsSink." + }, + "name": { + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", + "type": "string" + }, + "description": { + "description": "A description of the sink.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "DiagnosticsSinkKind": { + "type": "string", + "description": "The kind of DiagnosticsSink.", + "enum": [ + "Invalid", + "AzureInternalMonitoringPipeline" + ], + "x-ms-enum": { + "name": "DiagnosticsSinkKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva." + } + ] + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + ], + "x-ms-discriminator-value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva.", + "properties": { + "accountName": { + "description": "Azure Internal monitoring pipeline account.", + "type": "string" + }, + "namespace": { + "description": "Azure Internal monitoring pipeline account namespace.", + "type": "string" + }, + "maConfigUrl": { + "description": "Azure Internal monitoring agent configuration.", + "type": "string" + }, + "fluentdConfigUrl": { + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", + "type": "string" + } + } + } + }, + "parameters": { + "api-versionRequiredQueryParam": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-07-01-preview" + ], + "default": "2018-07-01-preview", + "description": "The version of the API. This parameter is required and its value must be `2018-07-01-preview`.", + "required": true, + "x-ms-enum": { + "name": "2018-07-01-preview", + "modelAsString": true, + "values": [ + { + "value": "2018-07-01-preview", + "description": "The `2018-07-01-preview` version of the API." + } + ] + } + }, + "subscriptionIdRequiredPathParam": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier", + "required": true, + "type": "string" + }, + "ResourceGroupNameRequiredPathParam": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApplicationNameRequiredPathParam": { + "name": "applicationName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating an application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ServiceNameRequiredPathParam": { + "name": "serviceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service." + }, + "ReplicaNameRequiredPathParam": { + "name": "replicaName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service replica." + }, + "NetworkNameRequiredPathParam": { + "name": "networkName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "VolumeNameRequiredPathParam": { + "name": "volumeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the code package." + }, + "TailOptionalQueryParam": { + "name": "tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100." + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json index 0b3a16bfc6c5..a4c1c410c18d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json @@ -1,315 +1,315 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-05-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current": { - "get": { - "tags": [ - "DatabaseAutomaticTuning" - ], - "description": "Gets a database's automatic tuning.", - "operationId": "DatabaseAutomaticTuning_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved database automatic tuning properties.", - "schema": { - "$ref": "#/definitions/DatabaseAutomaticTuning" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." - } - }, - "x-ms-examples": { - "Get a database's automatic tuning settings": { - "$ref": "./examples/DatabaseAutomaticTuningGet.json" - } - } - }, - "patch": { - "tags": [ - "DatabaseAutomaticTuning" - ], - "description": "Update automatic tuning properties for target database.", - "operationId": "DatabaseAutomaticTuning_Update", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The requested automatic tuning resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/DatabaseAutomaticTuning" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the specified database automatic tuning settings.", - "schema": { - "$ref": "#/definitions/DatabaseAutomaticTuning" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidAutomaticTuningUpsertRequest - The update automatic tuning request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." - } - }, - "x-ms-examples": { - "Updates database automatic tuning settings with minimal properties": { - "$ref": "./examples/DatabaseAutomaticTuningUpdateMin.json" - }, - "Updates database automatic tuning settings with all properties": { - "$ref": "./examples/DatabaseAutomaticTuningUpdateMax.json" - } - } - } - } - }, - "definitions": { - "DatabaseAutomaticTuningProperties": { - "description": "Database-level Automatic Tuning properties.", - "type": "object", - "properties": { - "desiredState": { - "description": "Automatic tuning desired state.", - "enum": [ - "Inherit", - "Custom", - "Auto", - "Unspecified" - ], - "type": "string", - "x-ms-enum": { - "name": "AutomaticTuningMode", - "modelAsString": false - } - }, - "actualState": { - "description": "Automatic tuning actual state.", - "enum": [ - "Inherit", - "Custom", - "Auto", - "Unspecified" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningMode", - "modelAsString": false - } - }, - "options": { - "description": "Automatic tuning options definition.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AutomaticTuningOptions" - } - } - } - }, - "AutomaticTuningOptions": { - "description": "Automatic tuning properties for individual advisors.", - "type": "object", - "properties": { - "desiredState": { - "description": "Automatic tuning option desired state.", - "enum": [ - "Off", - "On", - "Default" - ], - "type": "string", - "x-ms-enum": { - "name": "AutomaticTuningOptionModeDesired", - "modelAsString": false - } - }, - "actualState": { - "description": "Automatic tuning option actual state.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningOptionModeActual", - "modelAsString": false - } - }, - "reasonCode": { - "format": "int32", - "description": "Reason code if desired and actual state are different.", - "type": "integer", - "readOnly": true - }, - "reasonDesc": { - "description": "Reason description if desired and actual state are different.", - "enum": [ - "Default", - "Disabled", - "AutoConfigured", - "InheritedFromServer", - "QueryStoreOff", - "QueryStoreReadOnly", - "NotSupported" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningDisabledReason", - "modelAsString": false - } - } - } - }, - "DatabaseAutomaticTuning": { - "description": "Database-level Automatic Tuning.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseAutomaticTuningProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2015-05-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/automaticTuning/current": { + "get": { + "tags": [ + "DatabaseAutomaticTuning" + ], + "description": "Gets a database's automatic tuning.", + "operationId": "DatabaseAutomaticTuning_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved database automatic tuning properties.", + "schema": { + "$ref": "#/definitions/DatabaseAutomaticTuning" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-examples": { + "Get a database's automatic tuning settings": { + "$ref": "./examples/DatabaseAutomaticTuningGet.json" + } + } + }, + "patch": { + "tags": [ + "DatabaseAutomaticTuning" + ], + "description": "Update automatic tuning properties for target database.", + "operationId": "DatabaseAutomaticTuning_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested automatic tuning resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAutomaticTuning" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the specified database automatic tuning settings.", + "schema": { + "$ref": "#/definitions/DatabaseAutomaticTuning" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidAutomaticTuningUpsertRequest - The update automatic tuning request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-examples": { + "Updates database automatic tuning settings with minimal properties": { + "$ref": "./examples/DatabaseAutomaticTuningUpdateMin.json" + }, + "Updates database automatic tuning settings with all properties": { + "$ref": "./examples/DatabaseAutomaticTuningUpdateMax.json" + } + } + } + } + }, + "definitions": { + "DatabaseAutomaticTuningProperties": { + "description": "Database-level Automatic Tuning properties.", + "type": "object", + "properties": { + "desiredState": { + "description": "Automatic tuning desired state.", + "enum": [ + "Inherit", + "Custom", + "Auto", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "name": "AutomaticTuningMode", + "modelAsString": false + } + }, + "actualState": { + "description": "Automatic tuning actual state.", + "enum": [ + "Inherit", + "Custom", + "Auto", + "Unspecified" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningMode", + "modelAsString": false + } + }, + "options": { + "description": "Automatic tuning options definition.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AutomaticTuningOptions" + } + } + } + }, + "AutomaticTuningOptions": { + "description": "Automatic tuning properties for individual advisors.", + "type": "object", + "properties": { + "desiredState": { + "description": "Automatic tuning option desired state.", + "enum": [ + "Off", + "On", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "AutomaticTuningOptionModeDesired", + "modelAsString": false + } + }, + "actualState": { + "description": "Automatic tuning option actual state.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningOptionModeActual", + "modelAsString": false + } + }, + "reasonCode": { + "format": "int32", + "description": "Reason code if desired and actual state are different.", + "type": "integer", + "readOnly": true + }, + "reasonDesc": { + "description": "Reason description if desired and actual state are different.", + "enum": [ + "Default", + "Disabled", + "AutoConfigured", + "InheritedFromServer", + "QueryStoreOff", + "QueryStoreReadOnly", + "NotSupported" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningDisabledReason", + "modelAsString": false + } + } + } + }, + "DatabaseAutomaticTuning": { + "description": "Database-level Automatic Tuning.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseAutomaticTuningProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json index 738cf42b87a1..0fcc35717d61 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CancelJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json index 7185227b97dc..33bd949cbf77 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json index 6d60ca66c4c9..d10eabe8ce18 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json index 97ffd1929152..ecdef5bbcadc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobAgentMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json index eeaea016ac57..59fd0c72e315 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json index 1500f334a66c..ebda400ac79d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json index 2cf760d4fc1b..47ccbb14a422 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json index 600e41ed57f3..6e54f084af4f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json index 49e0b1e00408..1c2cc554d055 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json index c82be7b92fcf..63a3c89525dc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobStepMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json index e3b725a69ec6..7913341cb690 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json index 009e8c4c4c48..91cebdfb494c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/CreateOrUpdateJobTargetGroupMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DataWarehouseRestorePointsGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DataWarehouseRestorePointsGet.json index 2315fcd40e43..539a3c876321 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DataWarehouseRestorePointsGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DataWarehouseRestorePointsGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsDelete.json index 27113d2984f2..8e8c4a46a4fa 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsGet.json index 6f23a9268e37..831adeef822f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsPost.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsPost.json index 2999b939668b..078430371eae 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsPost.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseRestorePointsPost.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json index 93c7d3fcbe42..b924799c02bd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json index 04937e03c77e..621272a80253 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json index 52d78ada8c4c..9de9c1a375c0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json index 853de7852d2e..dee50fcd08fa 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobStep.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json index 5ea4adaff001..b93e3f88e032 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DeleteJobTargetGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json index 115b12a9abbc..577437a4fb07 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json index 365bd7a89967..b98c93872916 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json index b053ca63e8db..69798a51034e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobCredential.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json index 505f2a642880..1779769b1655 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json index 62d938798c72..f0490f13d46f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionStep.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json index ab40d8ad004c..0e373fb91bcc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobExecutionTarget.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json index 48fa100ecede..331fc0690c64 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json index 6ea970f0e94b..4b5a5b272c58 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobStepByVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json index 1452bd2ea7e1..e79a3037415c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobTargetGroup.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json index 2585927282f2..56143c2846b6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetJobVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json index 68f4e749f77f..4195da329cf2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobAgentsByServer.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json index 86351ed3dfa7..76c5ebf69cdd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobCredentialsByAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json index f91a132855f8..defd1ce5ce9f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionSteps.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json index 1325b6cdd062..d634cb871d32 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByExecution.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json index d060af56d88d..95f44e988623 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionTargetsByStep.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json index b2c4e9a7b248..0131420f4ecd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByAgentWithFilter.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json index 00a1fc94a267..2e2d7e15e89b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobExecutionsByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json index 571e1a83648b..59d4f6a77aa9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByJob.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json index f7fd74cd38b0..f112a3802d00 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobStepsByVersion.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json index 3d601b7fc3c8..d951f67bbc24 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobTargetGroups.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json index 1bef2f1c0c6a..61224a8b7ae0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobVersions.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json index f5bc7284cec9..95222e79bf43 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ListJobsByAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupDelete.json index 2f8c565ce8b9..e38f7abb3a8c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "locationName": "japaneast", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupGet.json index 2a33e742f05c..e74374a5935b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "locationName": "japaneast", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByDatabase.json index ef67ab2efa19..ad875a085557 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByDatabase.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "locationName": "japaneast", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByLocation.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByLocation.json index 391ece01551d..3fcc93dfd4e4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByLocation.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByLocation.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "locationName": "japaneast", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByServer.json index 45a66c5412dd..f094573aafdd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByServer.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionBackupListByServer.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "locationName": "japaneast", - "longTermRetentionServerName": "testserver", - "api-version": "2017-03-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase1/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000", - "name": "55555555-6666-7777-8888-999999999999;131637960820000000", - "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", - "properties": { - "serverName": "testserver", - "serverCreateTime": "2017-03-10T08:00:00.000Z", - "databaseName": "testDatabase1", - "databaseDeletionTime": null, - "backupTime": "2017-08-23T08:00:00.000Z" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase2/longTermRetentionBackups/12341234-1234-1234-1234-123123123123;131657960820000000", - "name": "12341234-1234-1234-1234-123123123123;131657960820000000", - "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", - "properties": { - "serverName": "testserver", - "serverCreateTime": "2017-03-10T08:00:00.000Z", - "databaseName": "testDatabase2", - "databaseDeletionTime": null, - "backupTime": "2017-08-30T08:00:00.000Z" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase3/longTermRetentionBackups/43214321-4321-4321-4321-321321321321;131677960820000000", - "name": "43214321-4321-4321-4321-321321321321;131667960820000000", - "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", - "properties": { - "serverName": "testserver", - "serverCreateTime": "2017-03-10T08:00:00.000Z", - "databaseName": "testDatabase3", - "databaseDeletionTime": null, - "backupTime": "2017-09-06T08:00:00.000Z" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "locationName": "japaneast", + "longTermRetentionServerName": "testserver", + "api-version": "2017-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase1/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000", + "name": "55555555-6666-7777-8888-999999999999;131637960820000000", + "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", + "properties": { + "serverName": "testserver", + "serverCreateTime": "2017-03-10T08:00:00.000Z", + "databaseName": "testDatabase1", + "databaseDeletionTime": null, + "backupTime": "2017-08-23T08:00:00.000Z" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase2/longTermRetentionBackups/12341234-1234-1234-1234-123123123123;131657960820000000", + "name": "12341234-1234-1234-1234-123123123123;131657960820000000", + "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", + "properties": { + "serverName": "testserver", + "serverCreateTime": "2017-03-10T08:00:00.000Z", + "databaseName": "testDatabase2", + "databaseDeletionTime": null, + "backupTime": "2017-08-30T08:00:00.000Z" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase3/longTermRetentionBackups/43214321-4321-4321-4321-321321321321;131677960820000000", + "name": "43214321-4321-4321-4321-321321321321;131667960820000000", + "type": "Microsoft.Sql/locations/longTermRetentionServers/longTermRetentionDatabases/longTermRetentionBackups", + "properties": { + "serverName": "testserver", + "serverCreateTime": "2017-03-10T08:00:00.000Z", + "databaseName": "testDatabase3", + "databaseDeletionTime": null, + "backupTime": "2017-09-06T08:00:00.000Z" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json index dea59f79b96b..98fbaadcc1bd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "resourceGroup", - "serverName": "testserver", - "databaseName": "testDatabase", - "policyName" : "default", - "api-version": "2017-03-01", - "parameters" : { - "weeklyRetention": "P1M", - "monthlyRetention": "P1Y", - "yearlyRetention": "P5Y", - "weekOfYear": 5 - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default", - "name": "default", - "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies", - "properties" : { - "weeklyRetention": "P1M", - "monthlyRetention": "P1Y", - "yearlyRetention": "P5Y", - "weekOfYear": 5 - } - } - }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup", + "serverName": "testserver", + "databaseName": "testDatabase", + "policyName" : "default", + "api-version": "2017-03-01", + "parameters" : { + "weeklyRetention": "P1M", + "monthlyRetention": "P1Y", + "yearlyRetention": "P5Y", + "weekOfYear": 5 + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testserver/databases/testDatabase/backupLongTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/resourceGroups/servers/databases/backupLongTermRetentionPolicies", + "properties" : { + "weeklyRetention": "P1M", + "monthlyRetention": "P1Y", + "yearlyRetention": "P5Y", + "weekOfYear": 5 + } + } + }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyGet.json index 97517d41a31a..a594362f0d21 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "resourceGroup", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json index 5b90cf7227b6..65706e3c02c8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json index dc8110cb783b..4143d1c4dfee 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json index 35e787d9b8d3..2f950088217f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json index b548481d70ed..c95c4f12808e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json index f2f90b41b6e8..6b85d94aee22 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json index 20605c075e18..6f1addb900ce 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Test1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json index 605b6eaef54c..1d4f9899720a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseListByManagedInstance.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Test1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json index 1f105bbaf543..fea44768a241 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMax.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json index 1f105bbaf543..fea44768a241 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseUpdateMin.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default-SQL-SouthEastAsia", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasAcquire.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasAcquire.json index 66342bc445b7..cf1d70ff6266 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasAcquire.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasAcquire.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasCreateOrUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasCreateOrUpdate.json index b2bb2e446fdf..93cb1edada21 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasCreateOrUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasCreateOrUpdate.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasDelete.json index e356667b12f2..e77d43485452 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasDelete.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasGet.json index 25ae46277c9b..d6dc4e58476b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasGet.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasList.json index 4efa8de0ea38..55efa6f657b5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerDnsAliasList.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "Default", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json index b1fefbfea663..8d96b1e2658a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateJobAgent.json @@ -1,4 +1,4 @@ -{ +{ "parameters":{ "subscriptionId":"00000000-1111-2222-3333-444444444444", "resourceGroupName":"group1", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json index 8049cf5fefca..637d04bfd519 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json @@ -1,708 +1,708 @@ -{ - "swagger": "2.0", - "info": { - "version": "2017-03-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}": { - "get": { - "tags": [ - "LongTermRetentionBackups" - ], - "description": "Gets a long term retention backup.", - "operationId": "LongTermRetentionBackups_Get", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The location of the database.", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionServerName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "backupName", - "in": "path", - "description": "The backup name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the backup.", - "schema": { - "$ref": "#/definitions/LongTermRetentionBackup" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-examples": { - "Get the long term retention backup.": { - "$ref": "./examples/LongTermRetentionBackupGet.json" - } - } - }, - "delete": { - "tags": [ - "LongTermRetentionBackups" - ], - "description": "Deletes a long term retention backup.", - "operationId": "LongTermRetentionBackups_Delete", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The location of the database", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionServerName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "backupName", - "in": "path", - "description": "The backup name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the backup." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete the long term retention backup.": { - "$ref": "./examples/LongTermRetentionBackupDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups": { - "get": { - "tags": [ - "LongTermRetentionBackups" - ], - "description": "Lists all long term retention backups for a database.", - "operationId": "LongTermRetentionBackups_ListByDatabase", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The location of the database", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionServerName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "onlyLatestPerDatabase", - "in": "query", - "description": "Whether or not to only get the latest backup for each database.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of backups.", - "schema": { - "$ref": "#/definitions/LongTermRetentionBackupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get all long term retention backups under the database.": { - "$ref": "./examples/LongTermRetentionBackupListByDatabase.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups": { - "get": { - "tags": [ - "LongTermRetentionBackups" - ], - "description": "Lists the long term retention backups for a given location.", - "operationId": "LongTermRetentionBackups_ListByLocation", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The location of the database", - "required": true, - "type": "string" - }, - { - "name": "onlyLatestPerDatabase", - "in": "query", - "description": "Whether or not to only get the latest backup for each database.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of backups.", - "schema": { - "$ref": "#/definitions/LongTermRetentionBackupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get all long term retention backups under the location.": { - "$ref": "./examples/LongTermRetentionBackupListByLocation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups": { - "get": { - "tags": [ - "LongTermRetentionBackups" - ], - "description": "Lists the long term retention backups for a given server.", - "operationId": "LongTermRetentionBackups_ListByServer", - "parameters": [ - { - "name": "locationName", - "in": "path", - "description": "The location of the database", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionServerName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "onlyLatestPerDatabase", - "in": "query", - "description": "Whether or not to only get the latest backup for each database.", - "required": false, - "type": "boolean" - }, - { - "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of backups.", - "schema": { - "$ref": "#/definitions/LongTermRetentionBackupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get all long term retention backups under the server.": { - "$ref": "./examples/LongTermRetentionBackupListByServer.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}": { - "get": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "description": "Gets a database's long term retention policy.", - "operationId": "BackupLongTermRetentionPolicies_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "policyName", - "in": "path", - "description": "The policy name. Should always be Default.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "LongTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully get the policy.", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-examples": { - "Get the long term retention policy for the database.": { - "$ref": "./examples/LongTermRetentionPolicyGet.json" - } - } - }, - "put": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "description": "Sets a database's long term retention policy.", - "operationId": "BackupLongTermRetentionPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "policyName", - "in": "path", - "description": "The policy name. Should always be Default.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "LongTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The long term retention policy info.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully set the policy.", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create or update the long term retention policy for the database.": { - "$ref": "./examples/LongTermRetentionPolicyCreateOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies": { - "get": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "description": "Gets a database's long term retention policy.", - "operationId": "BackupLongTermRetentionPolicies_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully get the policy.", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-examples": { - "Get the long term retention policy for the database.": { - "$ref": "./examples/LongTermRetentionPolicyGet.json" - } - } - } - } - }, - "definitions": { - "LongTermRetentionBackupProperties": { - "description": "Properties of a long term retention backup", - "type": "object", - "properties": { - "serverName": { - "description": "The server name that the backup database belong to.", - "type": "string", - "readOnly": true - }, - "serverCreateTime": { - "format": "date-time", - "description": "The create time of the server.", - "type": "string", - "readOnly": true - }, - "databaseName": { - "description": "The name of the database the backup belong to", - "type": "string", - "readOnly": true - }, - "databaseDeletionTime": { - "format": "date-time", - "description": "The delete time of the database", - "type": "string", - "readOnly": true - }, - "backupTime": { - "format": "date-time", - "description": "The time the backup was taken", - "type": "string", - "readOnly": true - }, - "backupExpirationTime": { - "format": "date-time", - "description": "The time the long term retention backup will expire.", - "type": "string", - "readOnly": true - } - } - }, - "LongTermRetentionBackup": { - "description": "A long term retention backup.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/LongTermRetentionBackupProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, - "LongTermRetentionBackupListResult": { - "description": "A list of long term retention bacukps.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/LongTermRetentionBackup" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "LongTermRetentionPolicyProperties": { - "description": "Properties of a long term retention policy", - "type": "object", - "properties": { - "weeklyRetention": { - "description": "The weekly retention policy for an LTR backup in an ISO 8601 format.", - "type": "string" - }, - "monthlyRetention": { - "description": "The montly retention policy for an LTR backup in an ISO 8601 format.", - "type": "string" - }, - "yearlyRetention": { - "description": "The yearly retention policy for an LTR backup in an ISO 8601 format.", - "type": "string" - }, - "weekOfYear": { - "format": "int32", - "description": "The week of year to take the yearly backup in an ISO 8601 format.", - "type": "integer" - } - } - }, - "BackupLongTermRetentionPolicy": { - "description": "A long term retention policy.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/LongTermRetentionPolicyProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "LongTermRetentionDatabaseStateParameter": { - "name": "databaseState", - "in": "query", - "description": "Whether to query against just live databases, just deleted databases, or all databases.", - "required": false, - "type": "string", - "enum": [ - "All", - "Live", - "Deleted" - ], - "x-ms-enum": { - "name": "longTermRetentionDatabaseState", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}": { + "get": { + "tags": [ + "LongTermRetentionBackups" + ], + "description": "Gets a long term retention backup.", + "operationId": "LongTermRetentionBackups_Get", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The location of the database.", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionServerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "backupName", + "in": "path", + "description": "The backup name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the backup.", + "schema": { + "$ref": "#/definitions/LongTermRetentionBackup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the long term retention backup.": { + "$ref": "./examples/LongTermRetentionBackupGet.json" + } + } + }, + "delete": { + "tags": [ + "LongTermRetentionBackups" + ], + "description": "Deletes a long term retention backup.", + "operationId": "LongTermRetentionBackups_Delete", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The location of the database", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionServerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "backupName", + "in": "path", + "description": "The backup name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the backup." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the long term retention backup.": { + "$ref": "./examples/LongTermRetentionBackupDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups": { + "get": { + "tags": [ + "LongTermRetentionBackups" + ], + "description": "Lists all long term retention backups for a database.", + "operationId": "LongTermRetentionBackups_ListByDatabase", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The location of the database", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionServerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "onlyLatestPerDatabase", + "in": "query", + "description": "Whether or not to only get the latest backup for each database.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of backups.", + "schema": { + "$ref": "#/definitions/LongTermRetentionBackupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get all long term retention backups under the database.": { + "$ref": "./examples/LongTermRetentionBackupListByDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionBackups": { + "get": { + "tags": [ + "LongTermRetentionBackups" + ], + "description": "Lists the long term retention backups for a given location.", + "operationId": "LongTermRetentionBackups_ListByLocation", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The location of the database", + "required": true, + "type": "string" + }, + { + "name": "onlyLatestPerDatabase", + "in": "query", + "description": "Whether or not to only get the latest backup for each database.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of backups.", + "schema": { + "$ref": "#/definitions/LongTermRetentionBackupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get all long term retention backups under the location.": { + "$ref": "./examples/LongTermRetentionBackupListByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionBackups": { + "get": { + "tags": [ + "LongTermRetentionBackups" + ], + "description": "Lists the long term retention backups for a given server.", + "operationId": "LongTermRetentionBackups_ListByServer", + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The location of the database", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionServerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "onlyLatestPerDatabase", + "in": "query", + "description": "Whether or not to only get the latest backup for each database.", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/LongTermRetentionDatabaseStateParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of backups.", + "schema": { + "$ref": "#/definitions/LongTermRetentionBackupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get all long term retention backups under the server.": { + "$ref": "./examples/LongTermRetentionBackupListByServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{policyName}": { + "get": { + "tags": [ + "BackupLongTermRetentionPolicies" + ], + "description": "Gets a database's long term retention policy.", + "operationId": "BackupLongTermRetentionPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be Default.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "LongTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully get the policy.", + "schema": { + "$ref": "#/definitions/BackupLongTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the long term retention policy for the database.": { + "$ref": "./examples/LongTermRetentionPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "BackupLongTermRetentionPolicies" + ], + "description": "Sets a database's long term retention policy.", + "operationId": "BackupLongTermRetentionPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be Default.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "LongTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The long term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupLongTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the policy.", + "schema": { + "$ref": "#/definitions/BackupLongTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 LongTermRetentionPolicyNotSupported - Long Term Retention is not supported on this database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update the long term retention policy for the database.": { + "$ref": "./examples/LongTermRetentionPolicyCreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies": { + "get": { + "tags": [ + "BackupLongTermRetentionPolicies" + ], + "description": "Gets a database's long term retention policy.", + "operationId": "BackupLongTermRetentionPolicies_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully get the policy.", + "schema": { + "$ref": "#/definitions/BackupLongTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the long term retention policy for the database.": { + "$ref": "./examples/LongTermRetentionPolicyGet.json" + } + } + } + } + }, + "definitions": { + "LongTermRetentionBackupProperties": { + "description": "Properties of a long term retention backup", + "type": "object", + "properties": { + "serverName": { + "description": "The server name that the backup database belong to.", + "type": "string", + "readOnly": true + }, + "serverCreateTime": { + "format": "date-time", + "description": "The create time of the server.", + "type": "string", + "readOnly": true + }, + "databaseName": { + "description": "The name of the database the backup belong to", + "type": "string", + "readOnly": true + }, + "databaseDeletionTime": { + "format": "date-time", + "description": "The delete time of the database", + "type": "string", + "readOnly": true + }, + "backupTime": { + "format": "date-time", + "description": "The time the backup was taken", + "type": "string", + "readOnly": true + }, + "backupExpirationTime": { + "format": "date-time", + "description": "The time the long term retention backup will expire.", + "type": "string", + "readOnly": true + } + } + }, + "LongTermRetentionBackup": { + "description": "A long term retention backup.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LongTermRetentionBackupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "LongTermRetentionBackupListResult": { + "description": "A list of long term retention bacukps.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/LongTermRetentionBackup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "LongTermRetentionPolicyProperties": { + "description": "Properties of a long term retention policy", + "type": "object", + "properties": { + "weeklyRetention": { + "description": "The weekly retention policy for an LTR backup in an ISO 8601 format.", + "type": "string" + }, + "monthlyRetention": { + "description": "The montly retention policy for an LTR backup in an ISO 8601 format.", + "type": "string" + }, + "yearlyRetention": { + "description": "The yearly retention policy for an LTR backup in an ISO 8601 format.", + "type": "string" + }, + "weekOfYear": { + "format": "int32", + "description": "The week of year to take the yearly backup in an ISO 8601 format.", + "type": "integer" + } + } + }, + "BackupLongTermRetentionPolicy": { + "description": "A long term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LongTermRetentionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LongTermRetentionDatabaseStateParameter": { + "name": "databaseState", + "in": "query", + "description": "Whether to query against just live databases, just deleted databases, or all databases.", + "required": false, + "type": "string", + "enum": [ + "All", + "Live", + "Deleted" + ], + "x-ms-enum": { + "name": "longTermRetentionDatabaseState", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json index 97f737c7d881..740943a3b7ff 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json @@ -1,303 +1,303 @@ -{ - "swagger": "2.0", - "info": { - "version": "2017-03-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/automaticTuning/current": { - "get": { - "tags": [ - "ServerAutomaticTuning" - ], - "description": "Retrieves server automatic tuning options.", - "operationId": "ServerAutomaticTuning_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved server automatic tuning properties.", - "schema": { - "$ref": "#/definitions/ServerAutomaticTuning" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." - } - }, - "x-ms-examples": { - "Get a server's automatic tuning settings": { - "$ref": "./examples/ServerAutomaticTuningGet.json" - } - } - }, - "patch": { - "tags": [ - "ServerAutomaticTuning" - ], - "description": "Update automatic tuning options on server.", - "operationId": "ServerAutomaticTuning_Update", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The requested automatic tuning resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerAutomaticTuning" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the server-level automatic tuning options.", - "schema": { - "$ref": "#/definitions/ServerAutomaticTuning" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidAutomaticTuningUpsertRequest - The update automatic tuning request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." - } - }, - "x-ms-examples": { - "Updates server automatic tuning settings with minimal properties": { - "$ref": "./examples/ServerAutomaticTuningUpdateMin.json" - }, - "Updates server automatic tuning settings with all properties": { - "$ref": "./examples/ServerAutomaticTuningUpdateMax.json" - } - } - } - } - }, - "definitions": { - "AutomaticTuningServerProperties": { - "description": "Server-level Automatic Tuning properties.", - "type": "object", - "properties": { - "desiredState": { - "description": "Automatic tuning desired state.", - "enum": [ - "Custom", - "Auto", - "Unspecified" - ], - "type": "string", - "x-ms-enum": { - "name": "AutomaticTuningServerMode", - "modelAsString": false - } - }, - "actualState": { - "description": "Automatic tuning actual state.", - "enum": [ - "Custom", - "Auto", - "Unspecified" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningServerMode", - "modelAsString": false - } - }, - "options": { - "description": "Automatic tuning options definition.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AutomaticTuningServerOptions" - } - } - } - }, - "AutomaticTuningServerOptions": { - "description": "Automatic tuning properties for individual advisors.", - "type": "object", - "properties": { - "desiredState": { - "description": "Automatic tuning option desired state.", - "enum": [ - "Off", - "On", - "Default" - ], - "type": "string", - "x-ms-enum": { - "name": "AutomaticTuningOptionModeDesired", - "modelAsString": false - } - }, - "actualState": { - "description": "Automatic tuning option actual state.", - "enum": [ - "Off", - "On" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningOptionModeActual", - "modelAsString": false - } - }, - "reasonCode": { - "format": "int32", - "description": "Reason code if desired and actual state are different.", - "type": "integer", - "readOnly": true - }, - "reasonDesc": { - "description": "Reason description if desired and actual state are different.", - "enum": [ - "Default", - "Disabled", - "AutoConfigured" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AutomaticTuningServerReason", - "modelAsString": false - } - } - } - }, - "ServerAutomaticTuning": { - "description": "Server-level Automatic Tuning.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/AutomaticTuningServerProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/automaticTuning/current": { + "get": { + "tags": [ + "ServerAutomaticTuning" + ], + "description": "Retrieves server automatic tuning options.", + "operationId": "ServerAutomaticTuning_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved server automatic tuning properties.", + "schema": { + "$ref": "#/definitions/ServerAutomaticTuning" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-examples": { + "Get a server's automatic tuning settings": { + "$ref": "./examples/ServerAutomaticTuningGet.json" + } + } + }, + "patch": { + "tags": [ + "ServerAutomaticTuning" + ], + "description": "Update automatic tuning options on server.", + "operationId": "ServerAutomaticTuning_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested automatic tuning resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerAutomaticTuning" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the server-level automatic tuning options.", + "schema": { + "$ref": "#/definitions/ServerAutomaticTuning" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidAutomaticTuningUpsertRequest - The update automatic tuning request body does not exist or has no properties object.\n\n * 400 InvalidAdvisorAutoExecuteStatus - Specified auto-execute status for the advisor is not allowed.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - The requested database was not found\n\n * 404 SubscriptionDoesNotHaveElasticPool - The requested elastic pool was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 Conflict - Request could not be processed because of conflict in the request.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-examples": { + "Updates server automatic tuning settings with minimal properties": { + "$ref": "./examples/ServerAutomaticTuningUpdateMin.json" + }, + "Updates server automatic tuning settings with all properties": { + "$ref": "./examples/ServerAutomaticTuningUpdateMax.json" + } + } + } + } + }, + "definitions": { + "AutomaticTuningServerProperties": { + "description": "Server-level Automatic Tuning properties.", + "type": "object", + "properties": { + "desiredState": { + "description": "Automatic tuning desired state.", + "enum": [ + "Custom", + "Auto", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "name": "AutomaticTuningServerMode", + "modelAsString": false + } + }, + "actualState": { + "description": "Automatic tuning actual state.", + "enum": [ + "Custom", + "Auto", + "Unspecified" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningServerMode", + "modelAsString": false + } + }, + "options": { + "description": "Automatic tuning options definition.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AutomaticTuningServerOptions" + } + } + } + }, + "AutomaticTuningServerOptions": { + "description": "Automatic tuning properties for individual advisors.", + "type": "object", + "properties": { + "desiredState": { + "description": "Automatic tuning option desired state.", + "enum": [ + "Off", + "On", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "AutomaticTuningOptionModeDesired", + "modelAsString": false + } + }, + "actualState": { + "description": "Automatic tuning option actual state.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningOptionModeActual", + "modelAsString": false + } + }, + "reasonCode": { + "format": "int32", + "description": "Reason code if desired and actual state are different.", + "type": "integer", + "readOnly": true + }, + "reasonDesc": { + "description": "Reason description if desired and actual state are different.", + "enum": [ + "Default", + "Disabled", + "AutoConfigured" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AutomaticTuningServerReason", + "modelAsString": false + } + } + } + }, + "ServerAutomaticTuning": { + "description": "Server-level Automatic Tuning.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AutomaticTuningServerProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json index e88d8eb9b0cc..d5d71a3ce365 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json @@ -1,208 +1,208 @@ -{ - "swagger": "2.0", - "info": { - "version": "2017-10-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/tdeCertificates": { - "post": { - "tags": [ - "ManagedInstanceTdeCertificates" - ], - "description": "Creates a TDE certificate for a given server.", - "operationId": "ManagedInstanceTdeCertificates_Create", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The requested TDE certificate to be created or updated.", - "required": true, - "schema": { - "$ref": "#/definitions/TdeCertificate" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully created the TDE certificate." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Upload a TDE certificate": { - "$ref": "./examples/ManagedInstanceTdeCertificate.json" - } - } - } - } - }, - "definitions": { - "TdeCertificateProperties": { - "description": "Properties of a TDE certificate.", - "required": [ - "privateBlob" - ], - "type": "object", - "properties": { - "privateBlob": { - "description": "The base64 encoded certificate private blob.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "certPassword": { - "description": "The certificate password.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - } - } - }, - "TdeCertificate": { - "description": "A TDE certificate that can be uploaded into a server.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/TdeCertificateProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2017-10-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/tdeCertificates": { + "post": { + "tags": [ + "ManagedInstanceTdeCertificates" + ], + "description": "Creates a TDE certificate for a given server.", + "operationId": "ManagedInstanceTdeCertificates_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested TDE certificate to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TdeCertificate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created the TDE certificate." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upload a TDE certificate": { + "$ref": "./examples/ManagedInstanceTdeCertificate.json" + } + } + } + } + }, + "definitions": { + "TdeCertificateProperties": { + "description": "Properties of a TDE certificate.", + "required": [ + "privateBlob" + ], + "type": "object", + "properties": { + "privateBlob": { + "description": "The base64 encoded certificate private blob.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "certPassword": { + "description": "The certificate password.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "TdeCertificate": { + "description": "A TDE certificate that can be uploaded into a server.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TdeCertificateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json index 9bec57c19e39..19d1b0ca11d8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json @@ -1,208 +1,208 @@ -{ - "swagger": "2.0", - "info": { - "version": "2017-10-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/tdeCertificates": { - "post": { - "tags": [ - "TdeCertificates" - ], - "description": "Creates a TDE certificate for a given server.", - "operationId": "TdeCertificates_Create", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "description": "The requested TDE certificate to be created or updated.", - "required": true, - "schema": { - "$ref": "#/definitions/TdeCertificate" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully created the TDE certificate." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Upload a TDE certificate": { - "$ref": "./examples/SqlTdeCertificateCreate.json" - } - } - } - } - }, - "definitions": { - "TdeCertificateProperties": { - "description": "Properties of a TDE certificate.", - "required": [ - "privateBlob" - ], - "type": "object", - "properties": { - "privateBlob": { - "description": "The base64 encoded certificate private blob.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "certPassword": { - "description": "The certificate password.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - } - } - }, - "TdeCertificate": { - "description": "A TDE certificate that can be uploaded into a server.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/TdeCertificateProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2017-10-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/tdeCertificates": { + "post": { + "tags": [ + "TdeCertificates" + ], + "description": "Creates a TDE certificate for a given server.", + "operationId": "TdeCertificates_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested TDE certificate to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TdeCertificate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created the TDE certificate." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 MissingPrivateBlob - The private blob is missing.\n\n * 400 InvalidPrivateBlobOrPassword - Invalid private blob or password specified.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upload a TDE certificate": { + "$ref": "./examples/SqlTdeCertificateCreate.json" + } + } + } + } + }, + "definitions": { + "TdeCertificateProperties": { + "description": "Properties of a TDE certificate.", + "required": [ + "privateBlob" + ], + "type": "object", + "properties": { + "privateBlob": { + "description": "The base64 encoded certificate private blob.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "certPassword": { + "description": "The certificate password.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "TdeCertificate": { + "description": "A TDE certificate that can be uploaded into a server.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TdeCertificateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json index d2188d3febc5..089f7b6ad2f7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetShortTermRetentionPolicy.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "serverName": "testsvr", - "databaseName": "testdb", - "policyName": "default", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", - "name": "default", - "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", - "properties": { - "retentionDays": 14 - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json index ad1be8eb3b1c..959605e97c7c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListShortTermRetentionPoliciesByDatabase.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Default-SQL-SouthEastAsia", - "serverName": "testsvr", - "databaseName": "testdb", - "policyName": "default", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", - "name":"default", - "type":"Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", - "properties": { - "retentionDays":14 - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name":"default", + "type":"Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays":14 + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json index 8dfc12219d81..762693cb8dd9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceTdeCertificate.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000001", - "resourceGroupName": "testtdecert", - "managedInstanceName": "testtdecert", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", - "password" : "password" - } - } - }, - "responses": { - "200": { }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "testtdecert", + "managedInstanceName": "testtdecert", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", + "password" : "password" + } + } + }, + "responses": { + "200": { }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json index 35803aff5fda..d5d0dcffb2b9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/SqlTdeCertificateCreate.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000001", - "resourceGroupName": "testtdecert", - "serverName": "testtdecert", - "tdeCertName": "current", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", - "password" : "password" - } - } - }, - "responses": { - "200": { }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "testtdecert", + "serverName": "testtdecert", + "tdeCertName": "current", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "privateBlob": "MIIJ+QIBAzCCCbUGCSqGSIb3DQEHAaCCCaYEggmiMIIJnjCCBhcGCSqGSIb3DQEHAaCCBggEggYEMIIGADCCBfwGCyqGSIb3DQEMCgECoIIE/jCCBPowHAYKKoZIhvcNAQwBAzAOBAgUeBd7F2KZUwICB9AEggTYSRi88/Xf0EZ9smyYDCr+jHa7a/510s19/5wjqGbLTT/CYBu2qSOhj+g9sNvjj5oWAcluaZ4XCl/oJhXlB+9q9ZYSC6pPhma7/Il+/zlZm8ZUMfgnUefpKXGj+Ilydghya2DOA0PONDGbqIJGBYC0JgtiL7WcYyA+LEiO0vXc2fZ+ccjQsHM+ePFOm6rTJ1oqE3quRC5Ls2Bv22PCmF+GWkWxqH1L5x8wR2tYfecEsx4sKMj318novQqBlJckOUPDrTT2ic6izFnDWS+zbGezSCeRkt2vjCUVDg7Aqm2bkmLVn+arA3tDZ/DBxgTwwt8prpAznDYG07WRxXMUk8Uqzmcds85jSMLSBOoRaS7GwIPprx0QwyYXd8H/go2vafuGCydRk8mA0bGLXjYWuYHAtztlGrE71a7ILqHY4XankohSAY4YF9Fc1mJcdtsuICs5vNosw1lf0VK5BR4ONCkiGFdYEKUpaUrzKpQiw3zteBN8RQs/ADKGWzaWERrkptf0pLH3/QnZvu9xwwnNWneygByPy7OVYrvgjD27x7Y/C24GyQweh75OTQN3fAvUj7IqeTVyWZGZq32AY/uUXYwASBpLbNUtUBfJ7bgyvVSZlPvcFUwDHJC1P+fSP8Vfcc9W3ec9HqVheXio7gYBEg9hZrOZwiZorl8HZJsEj5NxGccBme6hEVQRZfar5kFDHor/zmKohEAJVw8lVLkgmEuz8aqQUDSWVAcLbkfqygK/NxsR2CaC6xWroagQSRwpF8YbvqYJtAQvdkUXY9Ll4LSRcxKrWMZHgI+1Z22pyNtpy/kXLADche5CF3AVbHtzNNgn9L4GVuCW1Lqufu3U2+DEG+u53u1vraf45RS1y0IyLjTGC+8j0OTxcgUU6FrGgFny0m676v8potPrfyHvuOO511aOTe8UPBfnYyx0XHJPn8RaYGq0vMOBpFyfJkXtAnbRMgXjxxiO91yXTI2hbdVlAmOER1u8QemtF5PoKwZzaAjGBC5S0ARNtxZcWInGciGgtWJVVcyU6nJv3pa2T8jNvtcp8X7j+Il6j6Sju02L/f+S9MvAoGfgG6C5cInNIBEt7+mpYYV/6Mi9Nnj+8/Cq3eAMdTTo7XIzbFpeInzpVN2lAxPockRoAVj+odYO3CIBnzJ7mcA7JqtNk76vaWKasocMk9YS0Z+43o/Z5pZPwXvUv++UUv5fGRcsnIHEeQc+XJlSqRVoaLDo3mNRV6jp5GzJW2BZx3KkuLbohcmfBdr6c8ehGvHXhPm4k2jq9UNYvG9Gy58+1GqdhIYWbRc0Haid8H7UvvdkjA+Yul2rLj4fSTJ6yJ4f6xFAsFY7wIJthpik+dQO9lqPglo9DY30gEOXs3miuJmdmFtBoYlzxti4JBGwxXPwP3rtu6rY1JEOFsh1WmSEGE6Df2l9wtUQ0WAAD6bWgCxMiiRRv7TegxSeMtGn5QKuPC5lFuvzZvtJy1rR8WQwT7lVdHz32xLP2Rs4dayQPh08x3GsuI54d2kti2rcaSltGLRAOuODWc8KjYsPS6Ku4aN2NoQB5H9TEbHy2fsUNpNPMbCY54lH5bkgJtO4WmulnAHEApZG07u8G+Kk3a15npXemWgUW3N9gGtJ2XmieendXqS3RK1ZUYDsnAWW2jCZkjGB6jANBgkrBgEEAYI3EQIxADATBgkqhkiG9w0BCRUxBgQEAQAAADBXBgkqhkiG9w0BCRQxSh5IAGEAYgBjAGYAOABhADUAOQAtAGYAZQAzADIALQA0AGIAZgA0AC0AYQBiAGMAZgAtADkAOAA3AGIANwBmADgANwAzADEANgBjMGsGCSsGAQQBgjcRATFeHlwATQBpAGMAcgBvAHMAbwBmAHQAIABFAG4AaABhAG4AYwBlAGQAIABDAHIAeQBwAHQAbwBnAHIAYQBwAGgAaQBjACAAUAByAG8AdgBpAGQAZQByACAAdgAxAC4AMDCCA38GCSqGSIb3DQEHBqCCA3AwggNsAgEAMIIDZQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQMwDgQIbQcNiyMGeL4CAgfQgIIDOPSSP6SqJGYsXCPWCMQU0TqdqT55fauuadduHaAlQpyN0MVYdu9QguLqMaJjxWa8Coy3K7LAOcqJ4S8FWV2SrpTuNHPv7vrtZfYhltGl+vW8rIrogeGTV4T/45oc5605HSiyItOWX8vHYKnAJkRMW4ICZXgY3dZVb+fr6yPIRFvMywqzwkViVOJIKjZN2lsAQ0xlLU0Fu/va9uxADwI2ZUKfo+6nX6bITkLvUSJoNCvZ5e7UITasxC4ZauHdMZch38N7BPH2usrAQfr3omYcScFzSeN2onhE1JBURCPDQa8+CGiWMm6mxboUOIcUGasaDqYQ8pSAgZZqQf8lU0uH4FP/z/5Dd7PniDHjvqlwYa+vB6flgtrwh6jYFeTKluhkucLrfzusFR52kHpg8K4GaUL8MhvlsNdd8iHSFjfyOdXRpY9re+B8X9Eorx0Z3xsSsVWaCwmI+Spq+BZ5CSXVm9Um6ogeM0et8JciZS2yFLIlbl2o4U1BWblskYfj/29jm4/2UKjKzORZnpjE0O+qP4hReSrx6os9dr8sNkq/7OafZock8zXjXaOpW6bqB1V5NWMPiWiPxPxfRi1F/MQp6CPY03H7MsDALEFcF7MmtY4YpN/+FFfrrOwS19Fg0OnQzNIgFpSRywX9dxyKICt/wbvhM+RLpUN50ZekFVska+C27hJRJEZ9rSdVhOVdL1UNknuwqF1cCQQriaNsnCbeVHN3/Wgsms9+Kt+glBNyZQlU8Fk+fafcQFI5MlxyMmARVwnC70F8AScnJPPFVZIdgIrvOXCDrEh8wFgkVM/MHkaTZUF51yy3pbIZaPmNd5dsUfEvMsW2IY6esnUUxPRQUUoi5Ib8EFHdiQJrYY3ELfZRXb2I1Xd0DVhlGzogn3CXZtXR2gSAakdB0qrLpXMSJNS65SS2tVTD7SI8OpUGNRjthQIAEEROPue10geFUwarWi/3jGMG529SzwDUJ4g0ix6VtcuLIDYFNdClDTyEyeV1f70NSG2QVXPIpeF7WQ8jWK7kenGaqqna4C4FYQpQk9vJP171nUXLR2mUR11bo1N4hcVhXnJls5yo9u14BB9CqVKXeDl7M5zwMDswHzAHBgUrDgMCGgQUT6Tjuka1G4O/ZCBxO7NBR34YUYQEFLaheEdRIIuxUd25/hl5vf2SFuZuAgIH0A==", + "password" : "password" + } + } + }, + "responses": { + "200": { }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json index b2cccb516116..263395ca6808 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/UpdateShortTermRetentionPolicy.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "resourceGroup", - "serverName": "testsvr", - "databaseName": "testdb", - "policyName" : "default", - "api-version": "2017-10-01-preview", - "parameters": { - "properties" : { - "retentionDays": 14 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testsvr/databases/testdb/backupLongTermRetentionPolicies/default", - "name": "default", - "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", - "properties" : { - "retentionDays": 14 - } - } - }, - "202": {} - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup", + "serverName": "testsvr", + "databaseName": "testdb", + "policyName" : "default", + "api-version": "2017-10-01-preview", + "parameters": { + "properties" : { + "retentionDays": 14 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/resourceGroups/resourceGroup/servers/testsvr/databases/testdb/backupLongTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/locations/servers/databases/backupShortTermRetentionPolicies", + "properties" : { + "retentionDays": 14 + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json index 91d63c39fd80..92a4dccef42b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json @@ -1,399 +1,399 @@ -{ - "swagger": "2.0", - "info": { - "version": "2017-10-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}": { - "get": { - "tags": [ - "BackupShortTermRetentionPolicies" - ], - "description": "Gets a database's short term retention policy.", - "operationId": "BackupShortTermRetentionPolicies_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "policyName", - "in": "path", - "description": "The policy name. Should always be \"default\".", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "ShortTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the policy.", - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-examples": { - "Get the short term retention policy for the database.": { - "$ref": "./examples/GetShortTermRetentionPolicy.json" - } - } - }, - "put": { - "tags": [ - "BackupShortTermRetentionPolicies" - ], - "description": "Updates a database's short term retention policy.", - "operationId": "BackupShortTermRetentionPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "policyName", - "in": "path", - "description": "The policy name. Should always be \"default\".", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "ShortTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The short term retention policy info.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the policy.", - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update the short term retention policy for the database.": { - "$ref": "./examples/UpdateShortTermRetentionPolicy.json" - } - } - }, - "patch": { - "tags": [ - "BackupShortTermRetentionPolicies" - ], - "description": "Updates a database's short term retention policy.", - "operationId": "BackupShortTermRetentionPolicies_Update", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "policyName", - "in": "path", - "description": "The policy name. Should always be \"default\".", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "ShortTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The short term retention policy info.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the policy.", - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update the short term retention policy for the database.": { - "$ref": "./examples/UpdateShortTermRetentionPolicy.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies": { - "get": { - "tags": [ - "BackupShortTermRetentionPolicies" - ], - "description": "Gets a database's short term retention policy.", - "operationId": "BackupShortTermRetentionPolicies_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the policy.", - "schema": { - "$ref": "#/definitions/BackupShortTermRetentionPolicyListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get the short term retention policy for the database.": { - "$ref": "./examples/ListShortTermRetentionPoliciesByDatabase.json" - } - } - } - } - }, - "definitions": { - "BackupShortTermRetentionPolicyProperties": { - "description": "Properties of a short term retention policy", - "type": "object", - "properties": { - "retentionDays": { - "format": "int32", - "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", - "type": "integer" - } - } - }, - "BackupShortTermRetentionPolicy": { - "description": "A short term retention policy.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/BackupShortTermRetentionPolicyProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, - "BackupShortTermRetentionPolicyListResult": { - "description": "A list of short term retention policies.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/BackupShortTermRetentionPolicy" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } +{ + "swagger": "2.0", + "info": { + "version": "2017-10-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}": { + "get": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Gets a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/GetShortTermRetentionPolicy.json" + } + } + }, + "put": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Updates a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateShortTermRetentionPolicy.json" + } + } + }, + "patch": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Updates a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 UpdateShortTermRetentionFeatureNotSupportedForEdition - This feature is not available for the selected database's edition {0}.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateShortTermRetentionPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupShortTermRetentionPolicies": { + "get": { + "tags": [ + "BackupShortTermRetentionPolicies" + ], + "description": "Gets a database's short term retention policy.", + "operationId": "BackupShortTermRetentionPolicies_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/BackupShortTermRetentionPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/ListShortTermRetentionPoliciesByDatabase.json" + } + } + } + } + }, + "definitions": { + "BackupShortTermRetentionPolicyProperties": { + "description": "Properties of a short term retention policy", + "type": "object", + "properties": { + "retentionDays": { + "format": "int32", + "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", + "type": "integer" + } + } + }, + "BackupShortTermRetentionPolicy": { + "description": "A short term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupShortTermRetentionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "BackupShortTermRetentionPolicyListResult": { + "description": "A list of short term retention policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupShortTermRetentionPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerAdvisorCreateOrUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerAdvisorCreateOrUpdate.json index 83a135933896..b7f33d9f1f3a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerAdvisorCreateOrUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerAdvisorCreateOrUpdate.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "workloadinsight-demos", - "serverName": "misosisvr", - "advisorName": "CreateIndex", - "api-version": "2014-04-01", - "parameters": { - "properties": { - "autoExecuteValue": "Disabled" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "advisorStatus": "GA", - "autoExecuteValue": "Disabled" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/advisors/CreateIndex", - "name": "CreateIndex", - "type": "Microsoft.Sql/servers/advisors" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workloadinsight-demos", + "serverName": "misosisvr", + "advisorName": "CreateIndex", + "api-version": "2014-04-01", + "parameters": { + "properties": { + "autoExecuteValue": "Disabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advisorStatus": "GA", + "autoExecuteValue": "Disabled" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workloadinsight-demos/providers/Microsoft.Sql/servers/misosisvr/advisors/CreateIndex", + "name": "CreateIndex", + "type": "Microsoft.Sql/servers/advisors" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/CreateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/CreateJob.json index c9c016c38b63..b534fd1a18f9 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/CreateJob.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/CreateJob.json @@ -1,136 +1,136 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS", - "jobName": "test-by1-import", - "body": { - "location": "West US", - "properties": { - "storageAccountId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType": "Import", - "returnAddress": { - "recipientName": "Tets", - "streetAddress1": "Street1", - "streetAddress2": "street2", - "city": "Redmond", - "stateOrProvince": "wa", - "postalCode": "98007", - "countryOrRegion": "USA", - "phone": "4250000000", - "email": "Test@contoso.com" - }, - "diagnosticsPath": "waimportexport", - "logLevel": "Verbose", - "backupDriveManifest": true, - "driveList": [ - { - "driveId": "9CA995BB", - "bitLockerKey": "238810-662376-448998-450120-652806-203390-606320-483076", - "manifestFile": "\\DriveManifest.xml", - "manifestHash": "109B21108597EF36D5785F08303F3638", - "driveHeaderHash": "" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType":"Import", - "returnAddress":{ - "recipientName":"Tets", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"Test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 0000 0000" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Creating", - "driveList":[ - { - "driveId":"9CA995BB", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"109B21108597EF36D5785F08303F3638", - "driveHeaderHash":"", - "state":"Specified" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", - "name":"test-by1-import", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - }, - "201": { - "body": { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType":"Import", - "returnAddress":{ - "recipientName":"Tets", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"Test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 0000 0000" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Creating", - "driveList":[ - { - "driveId":"9CA995BB", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"109B21108597EF36D5785F08303F3638", - "driveHeaderHash":"", - "state":"Specified" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", - "name":"test-by1-import", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import", + "body": { + "location": "West US", + "properties": { + "storageAccountId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Tets", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "driveList": [ + { + "driveId": "9CA995BB", + "bitLockerKey": "238810-662376-448998-450120-652806-203390-606320-483076", + "manifestFile": "\\DriveManifest.xml", + "manifestHash": "109B21108597EF36D5785F08303F3638", + "driveHeaderHash": "" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + }, + "201": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/DeleteJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/DeleteJob.json index b2619aea61c4..7408d5d92625 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/DeleteJob.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/DeleteJob.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS", - "jobName": "test-by1-import" - }, - "responses": { - "200": { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType":"Import", - "returnAddress":{ - "recipientName":"Tets", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"Test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 0000 0000" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Creating", - "driveList":[ - { - "driveId":"9CA995BB", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"109B21108597EF36D5785F08303F3638", - "driveHeaderHash":"", - "state":"Specified" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", - "name":"test-by1-import", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetJob.json index da9bc9a3826f..1c166cc1d34f 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetJob.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetJob.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS", - "jobName": "test-by1-import" - }, - "responses": { - "200": { - "body": { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType":"Import", - "returnAddress":{ - "recipientName":"Tets", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"Test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 0000 0000" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Creating", - "driveList":[ - { - "driveId":"9CA995BB", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"109B21108597EF36D5785F08303F3638", - "driveHeaderHash":"", - "state":"Specified" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", - "name":"test-by1-import", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 0000 0000" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetLocation.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetLocation.json index d1b9d9e619cf..b791f05410f6 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetLocation.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/GetLocation.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "locationName": "West US" - }, - "responses": { - "200": { - "body": { - "properties":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 352 7600", - "supportedCarriers":[ - "FedEx" - ], - "alternateLocations":[ - "/providers/Microsoft.ImportExport/locations/westus" - ] - }, - "id":"/providers/Microsoft.ImportExport/locations/westus", - "name":"West US", - "type":"Microsoft.ImportExport/locations" - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "locationName": "West US" + }, + "responses": { + "200": { + "body": { + "properties":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600", + "supportedCarriers":[ + "FedEx" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/westus" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/westus", + "name":"West US", + "type":"Microsoft.ImportExport/locations" + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListBitLockerKeys.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListBitLockerKeys.json index 350059ad2f42..107257a77d0b 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListBitLockerKeys.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListBitLockerKeys.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS", - "jobName": "test-by1-import" - }, - "responses": { - "200": { - "body": { - "value":[ - { - "driveId":"9CA995BB", - "bitLockerKey":"000000-000000-111111-222222-333333-444444-555555-666666" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "driveId":"9CA995BB", + "bitLockerKey":"000000-000000-111111-222222-333333-444444-555555-666666" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInResourceGroup.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInResourceGroup.json index 8064e50d333d..ab42b024b5eb 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInResourceGroup.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInResourceGroup.json @@ -1,58 +1,58 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS" - }, - "responses": { - "200": { - "body": { - "value":[ - { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/xtprodtestwu", - "jobType":"Import", - "returnAddress":{ - "recipientName":"La", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 352 7600" - }, - "deliveryPackage":{ - "carrierName":"FedEx", - "trackingNumber":"787895108176", - "driveCount":1, - "shipDate":"9/29/2017 10:28:35 PM" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Received", - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-ssd-2", - "name":"test-by1-ssd-2", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/xtprodtestwu", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"787895108176", + "driveCount":1, + "shipDate":"9/29/2017 10:28:35 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Received", + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-ssd-2", + "name":"test-by1-ssd-2", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInSubscription.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInSubscription.json index 460ccc92f82c..97db839cfc5c 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInSubscription.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListJobsInSubscription.json @@ -1,121 +1,121 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" - }, - "responses": { - "200": { - "body": { - "value":[ - { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", - "jobType":"Import", - "returnAddress":{ - "recipientName":"La", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"city", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"425000000", - "email":"test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Windows Azure Import Export Service", - "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", - "streetAddress2":"", - "city":"Boydton", - "stateOrProvince":"VA", - "postalCode":"23917", - "countryOrRegion":"USA", - "phone":"+1-434-738-9443" - }, - "deliveryPackage":{ - "carrierName":"FedEx", - "trackingNumber":"992016102507", - "driveCount":1, - "shipDate":"8/11/2017 9:05:00 PM" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Received", - "driveList":[ - { - "driveId":"7PHR882C", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"E5D632DB047C74B3B17C8F3359950ADB", - "state":"Received" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-01", - "name":"test-bn1-import-cpu100-01", - "type":"Microsoft.ImportExport/jobs", - "location":"East US 2" - }, - { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", - "jobType":"Import", - "returnAddress":{ - "recipientName":"La", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"city", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4256150991", - "email":"test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Windows Azure Import Export Service", - "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", - "streetAddress2":"", - "city":"Boydton", - "stateOrProvince":"VA", - "postalCode":"23917", - "countryOrRegion":"USA", - "phone":"+1-434-738-9443" - }, - "deliveryPackage":{ - "carrierName":"FedEx", - "trackingNumber":"992016102508", - "driveCount":1, - "shipDate":"8/13/2017 7:32:23 PM" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Transferring", - "percentComplete":6, - "driveList":[ - { - "driveId":"KV6H86XP", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"F6A488A65AF0CCA7D050B7F9F43A197C", - "state":"CompletedMoreInfo", - "copyStatus":"InProgress", - "verboseLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194618-350_verbose.xml", - "errorLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-021_error.xml", - "manifestUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-574_manifest.xml" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-02", - "name":"test-bn1-import-cpu100-02", - "type":"Microsoft.ImportExport/jobs", - "location":"East US 2" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"city", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"425000000", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Windows Azure Import Export Service", + "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2":"", + "city":"Boydton", + "stateOrProvince":"VA", + "postalCode":"23917", + "countryOrRegion":"USA", + "phone":"+1-434-738-9443" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"992016102507", + "driveCount":1, + "shipDate":"8/11/2017 9:05:00 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Received", + "driveList":[ + { + "driveId":"7PHR882C", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"E5D632DB047C74B3B17C8F3359950ADB", + "state":"Received" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-01", + "name":"test-bn1-import-cpu100-01", + "type":"Microsoft.ImportExport/jobs", + "location":"East US 2" + }, + { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType":"Import", + "returnAddress":{ + "recipientName":"La", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"city", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4256150991", + "email":"test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Windows Azure Import Export Service", + "streetAddress1":"Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2":"", + "city":"Boydton", + "stateOrProvince":"VA", + "postalCode":"23917", + "countryOrRegion":"USA", + "phone":"+1-434-738-9443" + }, + "deliveryPackage":{ + "carrierName":"FedEx", + "trackingNumber":"992016102508", + "driveCount":1, + "shipDate":"8/13/2017 7:32:23 PM" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Transferring", + "percentComplete":6, + "driveList":[ + { + "driveId":"KV6H86XP", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"F6A488A65AF0CCA7D050B7F9F43A197C", + "state":"CompletedMoreInfo", + "copyStatus":"InProgress", + "verboseLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194618-350_verbose.xml", + "errorLogUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-021_error.xml", + "manifestUri":"https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-574_manifest.xml" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-02", + "name":"test-bn1-import-cpu100-02", + "type":"Microsoft.ImportExport/jobs", + "location":"East US 2" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListLocations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListLocations.json index 7ba574f49ed3..ad46df5f8dd3 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListLocations.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListLocations.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "api-version": "2016-11-01" - }, - "responses": { - "200": { - "body": { - "value":[ - { - "properties":{ - "recipientName":"Windows Azure Import/Export Service", - "streetAddress1":"Customer-A c/o NEXTDC Ltd, Delivery code ABCDEFG, 4 Eden Park Drive", - "streetAddress2":"", - "city":"Macquarie Park", - "stateOrProvince":"NSW", - "postalCode":"2113", - "countryOrRegion":"Australia", - "phone":"612 0000 0000", - "supportedCarriers":[ - "DHL" - ], - "alternateLocations":[ - "/providers/Microsoft.ImportExport/locations/australiaeast" - ] - }, - "id":"/providers/Microsoft.ImportExport/locations/australiaeast", - "name":"Australia East", - "type":"Microsoft.ImportExport/locations" - }, - { - "properties":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"Microsoft, c/o NEXTDC Ltd, Delivery code ABCDEFG, 826-830 Lorimer St, Port", - "streetAddress2":"", - "city":"Melbourne", - "stateOrProvince":"Melbourne", - "postalCode":"3207", - "countryOrRegion":"Australia", - "phone":"61 0 0000 0000", - "supportedCarriers":[ - "DHL" - ], - "alternateLocations":[ - "/providers/Microsoft.ImportExport/locations/australiasoutheast" - ] - }, - "id":"/providers/Microsoft.ImportExport/locations/australiasoutheast", - "name":"Australia Southeast", - "type":"Microsoft.ImportExport/locations" - } - ] - } - } - } +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "properties":{ + "recipientName":"Windows Azure Import/Export Service", + "streetAddress1":"Customer-A c/o NEXTDC Ltd, Delivery code ABCDEFG, 4 Eden Park Drive", + "streetAddress2":"", + "city":"Macquarie Park", + "stateOrProvince":"NSW", + "postalCode":"2113", + "countryOrRegion":"Australia", + "phone":"612 0000 0000", + "supportedCarriers":[ + "DHL" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/australiaeast" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/australiaeast", + "name":"Australia East", + "type":"Microsoft.ImportExport/locations" + }, + { + "properties":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"Microsoft, c/o NEXTDC Ltd, Delivery code ABCDEFG, 826-830 Lorimer St, Port", + "streetAddress2":"", + "city":"Melbourne", + "stateOrProvince":"Melbourne", + "postalCode":"3207", + "countryOrRegion":"Australia", + "phone":"61 0 0000 0000", + "supportedCarriers":[ + "DHL" + ], + "alternateLocations":[ + "/providers/Microsoft.ImportExport/locations/australiasoutheast" + ] + }, + "id":"/providers/Microsoft.ImportExport/locations/australiasoutheast", + "name":"Australia Southeast", + "type":"Microsoft.ImportExport/locations" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListOperations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListOperations.json index b144ee11d26c..43d1b308661f 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListOperations.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/ListOperations.json @@ -1,67 +1,67 @@ -{ - "parameters": { - "api-version": "2016-11-01" - }, - "responses": { - "200": { - "body": { - "value":[ - { - "name":"Microsoft.ImportExport/locations/read", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Locations", - "operation":"Get or List Locations", - "description":"Gets the properties for the specified location or returns the list of locations." - } - }, - { - "name":"Microsoft.ImportExport/jobs/write", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Jobs", - "operation":"Create or Update Job", - "description":"Creates a job with the specified parameters or update the properties or tags for the specified job." - } - }, - { - "name":"Microsoft.ImportExport/jobs/read", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Jobs", - "operation":"Get or List Jobs", - "description":"Gets the properties for the specified job or returns the list of jobs." - } - }, - { - "name":"Microsoft.ImportExport/jobs/listBitLockerKeys/action", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Jobs", - "operation":"List BitLocker Keys", - "description":"Gets the BitLocker keys for the specified job." - } - }, - { - "name":"Microsoft.ImportExport/jobs/delete", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Jobs", - "operation":"Delete Job", - "description":"Deletes an existing job." - } - }, - { - "name":"Microsoft.ImportExport/register/action", - "display":{ - "provider":"Microsoft Import/Export", - "resource":"Import/Export Resource Provider", - "operation":"Registers the Import/Export Resource Provider", - "description":"Registers the subscription for the import/export resource provider and enables the creation of import/export jobs." - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value":[ + { + "name":"Microsoft.ImportExport/locations/read", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Locations", + "operation":"Get or List Locations", + "description":"Gets the properties for the specified location or returns the list of locations." + } + }, + { + "name":"Microsoft.ImportExport/jobs/write", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Create or Update Job", + "description":"Creates a job with the specified parameters or update the properties or tags for the specified job." + } + }, + { + "name":"Microsoft.ImportExport/jobs/read", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Get or List Jobs", + "description":"Gets the properties for the specified job or returns the list of jobs." + } + }, + { + "name":"Microsoft.ImportExport/jobs/listBitLockerKeys/action", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"List BitLocker Keys", + "description":"Gets the BitLocker keys for the specified job." + } + }, + { + "name":"Microsoft.ImportExport/jobs/delete", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Jobs", + "operation":"Delete Job", + "description":"Deletes an existing job." + } + }, + { + "name":"Microsoft.ImportExport/register/action", + "display":{ + "provider":"Microsoft Import/Export", + "resource":"Import/Export Resource Provider", + "operation":"Registers the Import/Export Resource Provider", + "description":"Registers the subscription for the import/export resource provider and enables the creation of import/export jobs." + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/UpdateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/UpdateJob.json index c95a264b59e1..6a0bba757379 100644 --- a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/UpdateJob.json +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2016-11-01/examples/UpdateJob.json @@ -1,65 +1,65 @@ -{ - "parameters": { - "api-version": "2016-11-01", - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "Default-Storage-WestUS", - "jobName": "test-by1-import", - "body": { - "properties": { - "state": "", - "logLevel": "Verbose", - "backupDriveManifest": true - } - } - }, - "responses": { - "200": { - "body": { - "properties":{ - "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", - "jobType":"Import", - "returnAddress":{ - "recipientName":"Tets", - "streetAddress1":"Street1", - "streetAddress2":"street2", - "city":"Redmond", - "stateOrProvince":"wa", - "postalCode":"98007", - "countryOrRegion":"USA", - "phone":"4250000000", - "email":"Test@contoso.com" - }, - "shippingInformation":{ - "recipientName":"Microsoft Azure Import/Export Service", - "streetAddress1":"2045 Lafayette Street", - "streetAddress2":"", - "city":"Santa Clara", - "stateOrProvince":"CA", - "postalCode":"95050", - "countryOrRegion":"USA", - "phone":"408 352 7600" - }, - "diagnosticsPath":"waimportexport", - "logLevel":"Verbose", - "backupDriveManifest":true, - "cancelRequested":false, - "state":"Creating", - "driveList":[ - { - "driveId":"9CA995BB", - "manifestFile":"\\DriveManifest.xml", - "manifestHash":"109B21108597EF36D5785F08303F3638", - "driveHeaderHash":"", - "state":"Specified" - } - ], - "provisioningState":"Succeeded" - }, - "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-import", - "name":"test-by1-import", - "type":"Microsoft.ImportExport/jobs", - "location":"West US" - } - } - } +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "Default-Storage-WestUS", + "jobName": "test-by1-import", + "body": { + "properties": { + "state": "", + "logLevel": "Verbose", + "backupDriveManifest": true + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "storageAccountId":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType":"Import", + "returnAddress":{ + "recipientName":"Tets", + "streetAddress1":"Street1", + "streetAddress2":"street2", + "city":"Redmond", + "stateOrProvince":"wa", + "postalCode":"98007", + "countryOrRegion":"USA", + "phone":"4250000000", + "email":"Test@contoso.com" + }, + "shippingInformation":{ + "recipientName":"Microsoft Azure Import/Export Service", + "streetAddress1":"2045 Lafayette Street", + "streetAddress2":"", + "city":"Santa Clara", + "stateOrProvince":"CA", + "postalCode":"95050", + "countryOrRegion":"USA", + "phone":"408 352 7600" + }, + "diagnosticsPath":"waimportexport", + "logLevel":"Verbose", + "backupDriveManifest":true, + "cancelRequested":false, + "state":"Creating", + "driveList":[ + { + "driveId":"9CA995BB", + "manifestFile":"\\DriveManifest.xml", + "manifestHash":"109B21108597EF36D5785F08303F3638", + "driveHeaderHash":"", + "state":"Specified" + } + ], + "provisioningState":"Succeeded" + }, + "id":"/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/Default-Storage-WestUS/providers/Microsoft.ImportExport/jobs/test-by1-import", + "name":"test-by1-import", + "type":"Microsoft.ImportExport/jobs", + "location":"West US" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json index aa40e989b56d..a0b6154a71e1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview", - "parameters": { - "properties": { - "provisioningState": "Created", - "storageAccountKey": "storageaccountkeyvalue", - "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", - "storageAccountResourceId": "", - "storageAccountShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleCloudEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "friendlyName": "ankushbsubscriptionmgmtmab", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/cloudEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": { + "provisioningState": "Created", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "friendlyName": "ankushbsubscriptionmgmtmab", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/cloudEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json index 928e1f985f9d..b5ccf6fdd067 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json index ed74fda28ebb..552b04fb22ee 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleCloudEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "storageAccountKey": "storageaccountkeyvalue", - "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", - "storageAccountResourceId": "", - "storageAccountShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", - "friendlyName": "SampleAzureFileShareName_1", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json index ad6a75deedb6..66b144ae5a56 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", - "parameters": { - "name": "SampleServer-prod3.redmond.corp.microsoft.com", - "properties": { - "serverRole": "Standalone", - "provisioningState": "Created", - "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", - "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.277.0" - }, - "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "type": "10.91.86.47/storageSyncServices/registeredServers", - "name": "ankushb-prod3.redmond.corp.microsoft.com", - "properties": { - "serverId": "\"530a0384-50ac-456d-8240-9d6621404151\"", - "serverRole": "Standalone", - "provisioningState": "Succeeded", - "clusterId": "\"00000000-0000-0000-0000-000000000000\"", - "lastHeartBeat": "\"2017-08-21T13:24:18.2641509-07:00\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.278.0", - "storageSyncServiceUid": "\"56cfb290-f846-4c96-abc4-ee338bd252e8\"", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/c36c3bcb-a72e-492a-b700-4ad74a8e3d69" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "parameters": { + "name": "SampleServer-prod3.redmond.corp.microsoft.com", + "properties": { + "serverRole": "Standalone", + "provisioningState": "Created", + "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0" + }, + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "10.91.86.47/storageSyncServices/registeredServers", + "name": "ankushb-prod3.redmond.corp.microsoft.com", + "properties": { + "serverId": "\"530a0384-50ac-456d-8240-9d6621404151\"", + "serverRole": "Standalone", + "provisioningState": "Succeeded", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "lastHeartBeat": "\"2017-08-21T13:24:18.2641509-07:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.278.0", + "storageSyncServiceUid": "\"56cfb290-f846-4c96-abc4-ee338bd252e8\"", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/c36c3bcb-a72e-492a-b700-4ad74a8e3d69" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json index dcc4d32ee75d..77ed370cdf85 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json index ab6410ba74e3..66239532fab2 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", - "properties": { - "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", - "serverRole": "Standalone", - "provisioningState": "Created", - "clusterId": "\"00000000-0000-0000-0000-000000000000\"", - "clusterName": "", - "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.277.0", - "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", - "lastWorkflowId": "" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", + "properties": { + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "serverRole": "Standalone", + "provisioningState": "Created", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", + "lastWorkflowId": "" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json index 75cd89e9b722..5010aaf781d2 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "serverEndpointName": "SampleServerEndpoint_1", - "parameters": { - "properties": { - "provisioningState": "Created", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "cloudTiering": "off", - "volumeFreeSpacePercent": 100 - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "provisioningState": "Created", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json index 7c9a14e729c0..a56776d040c6 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json index d4afef4a2dfc..3d53b79d8267 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "friendlyName": "SampleRegisteredServer-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", - "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", - "syncErrorState": "0", - "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", - "syncErrorDirection": "none", - "syncErrorContext": "", - "itemDownloadErrorCount": 0, - "itemUploadErrorCount": 0, - "currentProgressType": "none", - "itemProgressCount": 0, - "itemTotalCount": 0, - "byteProgress": 0 - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "friendlyName": "SampleRegisteredServer-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", + "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", + "syncErrorState": "0", + "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", + "syncErrorDirection": "none", + "syncErrorContext": "", + "itemDownloadErrorCount": 0, + "itemUploadErrorCount": 0, + "currentProgressType": "none", + "itemProgressCount": 0, + "itemTotalCount": 0, + "byteProgress": 0 + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json index 21baf9772497..9d0e6b47f5b6 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "parameters" : { - "properties": { - "provisioningState": "Created", - "cloudTiering": "off", - "volumeFreeSpacePercent": 100 - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters" : { + "properties": { + "provisioningState": "Created", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json index 31429cb7d7ce..7fb1b01e89ff 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "parameters": { - "location": "WestUS", - "tags": {}, - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": {}, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "location": "WestUS", + "tags": {}, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": {}, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json index 26001b6c507a..445b5af000e0 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - }, - "204": { - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json index aa243d6bfe67..d0e22bc81ebe 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json index a930e70b6d43..b0a22de445fe 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2017-06-05-preview", - "parameters": { - "location": "WestUS", - "tags": { - "Environment": "Test", - "Dept": "IT" - }, - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices" - } - }, - "responses": { - "200": { - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": { - "Environment": "Test", - "Dept": "IT" - }, - "properties": {}, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview", + "parameters": { + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json index ccad6278ba86..b5272fd3a976 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview", - "parameters": { - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - - }, - "responses": { - "200": { - "body": { - "name": "SampleSyncGroup_1", - "properties": { - "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + + }, + "responses": { + "200": { + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json index f4db86a29658..c6979666be76 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json index 3acf7719e43d..dc72917fb604 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleSyncGroup_1", - "properties": { - "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", - "syncGroupStatus": "0" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", + "syncGroupStatus": "0" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json index 2cc2213d9548..939c2b0200a7 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", - "properties": { - "status": "succeeded", - "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", - "operation": "do", - "lastStepName": "runServerJob", - "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", - "type": "Microsoft.StorageSync/storageSyncServices/workflows" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "properties": { + "status": "succeeded", + "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", + "operation": "do", + "lastStepName": "runServerJob", + "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", + "type": "Microsoft.StorageSync/storageSyncServices/workflows" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json index 08433c1f1f36..66a543441686 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json @@ -1,3238 +1,3238 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Storage Sync", - "description": "Microsoft Storage Sync Service API", - "version": "2017-06-05-preview", - "x-ms-code-generation-settings": { - "name": "StorageSyncManagementClient" - } - }, - "host": "azure.microsoft.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.StorageSync/operations": { - "get": { - "tags": [ - "ResourceProvider", - "Operations" - ], - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "description": "Lists all of the available Storage Sync Rest API operations.", - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "responses": { - "200": { - "description": "Array of operations resources in the Resource Provider", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Storage Sync Service resource name.", - "required": true, - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Create", - "description": "Create a new StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Create": { - "$ref": "./examples/StorageSyncServices_Create.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object created/updated", - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Get", - "description": "Get a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Get": { - "$ref": "./examples/StorageSyncServices_Get.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object", - "schema": { - "$ref": "#/definitions/StorageSyncService" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "patch": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Storage Sync Service resource.", - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Update", - "description": "Patch a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Update": { - "$ref": "./examples/StorageSyncServices_Update.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object created/updated", - "schema": { - "$ref": "#/definitions/StorageSyncService" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Delete", - "description": "Delete a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Delete": { - "$ref": "./examples/StorageSyncServices_Delete.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object was deleted.", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "204": { - "description": "Storage Sync Service Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_ListByResourceGroup", - "description": "Get a StorageSyncService list by Resource group name.", - "x-ms-examples": { - "StorageSyncServices_ListByResourceGroup": { - "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of registered Storage Sync Service resources in the Resource Group", - "schema": { - "$ref": "#/definitions/StorageSyncServiceArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_ListBySubscription", - "description": "Get a StorageSyncService list by subscription.", - "x-ms-examples": { - "StorageSyncServices_ListBySubscription": { - "$ref": "./examples/StorageSyncServices_ListBySubscription.json" - } - }, - "responses": { - "200": { - "description": "Array of registered Storage Sync Service resources in the subscription.", - "schema": { - "$ref": "#/definitions/StorageSyncServiceArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_ListByStorageSyncService", - "description": "Get a SyncGroup List.", - "x-ms-examples": { - "SyncGroups_ListByStorageSyncService": { - "$ref": "./examples/SyncGroups_ListByStorageSyncService.json" - } - }, - "responses": { - "200": { - "description": "Array of Sync Group resources in Storage Sync Service", - "schema": { - "$ref": "#/definitions/SyncGroupArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Sync Group Body", - "required": true, - "schema": { - "$ref": "#/definitions/SyncGroup" - } - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Create", - "description": "Create a new SyncGroup.", - "x-ms-examples": { - "SyncGroups_Create": { - "$ref": "./examples/SyncGroups_Create.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object", - "schema": { - "$ref": "#/definitions/SyncGroup" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Get", - "description": "Get a given SyncGroup.", - "x-ms-examples": { - "SyncGroups_Get": { - "$ref": "./examples/SyncGroups_Get.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object", - "schema": { - "$ref": "#/definitions/SyncGroup" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Delete", - "description": "Delete a given SyncGroup.", - "x-ms-examples": { - "SyncGroups_Delete": { - "$ref": "./examples/SyncGroups_Delete.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object was deleted", - "headers": { - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint resource.", - "required": true, - "schema": { - "$ref": "#/definitions/CloudEndpoint" - } - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Create", - "description": "Create a new CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Create": { - "$ref": "./examples/CloudEndpoints_Create.json" - } - }, - "responses": { - "200": { - "description": "Cloud Endpoint object", - "schema": { - "$ref": "#/definitions/CloudEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Retry-After": { - "description": "Retry After", - "type": "string" - }, - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Get", - "description": "Get a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Get": { - "$ref": "./examples/CloudEndpoints_Get.json" - } - }, - "responses": { - "200": { - "description": "Cloud Endpoint object", - "schema": { - "$ref": "#/definitions/CloudEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Delete", - "description": "Delete a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Delete": { - "$ref": "./examples/CloudEndpoints_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Retry-After": { - "description": "Retry After", - "type": "string" - }, - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_ListBySyncGroup", - "description": "Get a CloudEndpoint List.", - "x-ms-examples": { - "CloudEndpoints_ListBySyncGroup": { - "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of Cloud Endpoint resources in Sync Group", - "schema": { - "$ref": "#/definitions/CloudEndpointArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Backup request.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PreBackup", - "description": "Pre Backup a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PreBackup": { - "$ref": "./examples/CloudEndpoints_PreBackup.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Backup request.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PostBackup", - "description": "Post Backup a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PostBackup": { - "$ref": "./examples/CloudEndpoints_PostBackup.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/PostBackupResponse" - }, - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/PreRestoreRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PreRestore", - "description": "Pre Restore a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PreRestore": { - "$ref": "./examples/CloudEndpoints_PreRestore.json" - } - }, - "responses": { - "200": { - "description": "Ok" - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_RestoreHeatbeat", - "description": "Restore Heartbeat a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_RestoreHeatbeat": { - "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json" - } - }, - "responses": { - "200": { - "description": "Restore Heartbeat Operation has ran successfully.", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/PostRestoreRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PostRestore", - "description": "Post Restore a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PostRestore": { - "$ref": "./examples/CloudEndpoints_PostRestore.json" - } - }, - "responses": { - "200": { - "description": "Ok" - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Server Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerEndpoint" - } - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Create", - "description": "Create a new ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Create": { - "$ref": "./examples/ServerEndpoints_Create.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Any of the properties applicable in PUT request.", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - } - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Update", - "description": "Patch a given ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Update": { - "$ref": "./examples/ServerEndpoints_Update.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Get", - "description": "Get a ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Get": { - "$ref": "./examples/ServerEndpoints_Get.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Delete", - "description": "Delete a given ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Delete": { - "$ref": "./examples/ServerEndpoints_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_ListBySyncGroup", - "description": "Get a ServerEndpoint list.", - "x-ms-examples": { - "ServerEndpoints_ListBySyncGroup": { - "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of Server Endpoint resources in Sync Group", - "schema": { - "$ref": "#/definitions/ServerEndpointArray" - }, - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource", - "Actions" - ], - "operationId": "ServerEndpoints_Recall", - "description": "Recall a serverendpoint.", - "x-ms-examples": { - "ServerEndpoints_Recall": { - "$ref": "./examples/ServerEndpoints_Recall.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_ListByStorageSyncService", - "description": "Get a given registered server list.", - "x-ms-examples": { - "RegisteredServers_ListByStorageSyncService": { - "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json" - } - }, - "responses": { - "200": { - "description": "Array of Registered Server resources in Storage Sync Service", - "schema": { - "$ref": "#/definitions/RegisteredServerArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Get", - "description": "Get a given registered server.", - "x-ms-examples": { - "RegisteredServers_Get": { - "$ref": "./examples/RegisteredServers_Get.json" - } - }, - "responses": { - "200": { - "description": "Registered Server resources in Sync Group", - "schema": { - "$ref": "#/definitions/RegisteredServer" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Registered Server object.", - "required": true, - "schema": { - "$ref": "#/definitions/RegisteredServer" - } - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Create", - "description": "Add a new registered server.", - "x-ms-examples": { - "RegisteredServers_Create": { - "$ref": "./examples/RegisteredServers_Create.json" - } - }, - "responses": { - "200": { - "description": "Registered Server resources in Sync Group", - "schema": { - "$ref": "#/definitions/RegisteredServer" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Delete", - "description": "Delete the given registered server.", - "x-ms-examples": { - "RegisteredServers_Delete": { - "$ref": "./examples/RegisteredServers_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronuous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "workflowId", - "in": "path", - "description": "workflow Id", - "required": true, - "type": "string" - } - ], - "tags": [ - "Workflow Resource" - ], - "operationId": "Workflows_Get", - "description": "Get Workflows resource", - "x-ms-examples": { - "Workflows_Get": { - "$ref": "./examples/Workflows_Get.json" - } - }, - "responses": { - "200": { - "description": "Workflow object", - "schema": { - "$ref": "#/definitions/Workflow" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "workflowId", - "in": "path", - "description": "workflow Id", - "required": true, - "type": "string" - } - ], - "tags": [ - "Workflow Resource", - "Actions" - ], - "operationId": "Workflows_Abort", - "description": "Abort the given workflow.", - "x-ms-examples": { - "Workflows_Abort": { - "$ref": "./examples/Workflows_Abort.json" - } - }, - "responses": { - "200": { - "description": "success", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - } - }, - "definitions": { - "StorageSyncError": { - "type": "object", - "description": "Error type", - "properties": { - "code": { - "type": "string", - "description": "Error code of the given entry." - }, - "message": { - "type": "string", - "description": "Error message of the given entry." - }, - "details": { - "$ref": "#/definitions/StorageSyncErrorDetails", - "description": "Error details of the given entry." - } - } - }, - "StorageSyncErrorDetails": { - "type": "object", - "description": "Error Details object.", - "properties": { - "code": { - "type": "string", - "description": "Error code of the given entry." - }, - "message": { - "type": "string", - "description": "Error message of the given entry." - }, - "target": { - "type": "string", - "description": "Target of the given entry." - } - } - }, - "Resource": { - "description": "The Azure Resource Manager resource.", - "properties": { - "id": { - "description": "The id of the resource.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the resource.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "The type of the resource", - "readOnly": true, - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The location of the resource.", - "type": "string" - }, - "tags": { - "description": "The tags of the resource.", - "type": "object" - } - } - }, - "SubscriptionState": { - "type": "object", - "description": "Subscription State object.", - "properties": { - "state": { - "type": "string", - "description": "State of Azure Subscription", - "enum": [ - "Registered", - "Unregistered", - "Warned", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": true - } - }, - "istransitioning": { - "type": "boolean", - "description": "Is Transitioning", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionStateProperties", - "description": "Subscription state properties." - } - } - }, - "StorageSyncService": { - "type": "object", - "description": "Storage Sync Service object.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageSyncServiceProperties", - "description": "Storage Sync Service properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "SyncGroup": { - "type": "object", - "description": "Sync Group object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SyncGroupProperties", - "description": "SyncGroup properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "CloudEndpoint": { - "type": "object", - "description": "Cloud Endpoint object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CloudEndpointProperties", - "description": "Cloud Endpoint properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "ServerEndpoint": { - "type": "object", - "description": "Server Endpoint object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerEndpointProperties", - "description": "Server Endpoint properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "RegisteredServer": { - "type": "object", - "description": "Registered Server resource.", - "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" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RegisteredServerProperties", - "description": "RegisteredServer properties." - } - }, - "x-ms-azure-resource": true - }, - "ResourcesMoveInfo": { - "type": "object", - "description": "Resource Move Info.", - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "Target resource group." - }, - "resources": { - "type": "array", - "description": "Collection of Resources.", - "items": { - "$ref": "#/definitions/ResourceId" - } - } - } - }, - "Workflow": { - "type": "object", - "description": "Workflow resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowProperties", - "description": "Workflow properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "OperationEntityListResult": { - "description": "The list of storage sync operations.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - } - } - }, - "OperationEntity": { - "description": "The operation supported by storage sync.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by storage sync." - }, - "origin": { - "type": "string", - "description": "The origin." - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by storage sync.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Microsoft StorageSync.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "OperationDisplayResource": { - "type": "object", - "description": "Operation Display Resource object.", - "properties": { - "provider": { - "type": "string", - "description": "Operation Display Resource Provider." - }, - "resource": { - "type": "string", - "description": "Operation Display Resource." - }, - "operation": { - "type": "string", - "description": "Operation Display Resource Operation." - }, - "description": { - "type": "string", - "description": "Operation Display Resource Description." - } - } - }, - "PostRestoreRequest": { - "type": "object", - "description": "Post Restore Request", - "properties": { - "partition": { - "type": "string", - "description": "Post Restore partition." - }, - "replicaGroup": { - "type": "string", - "description": "Post Restore replica group." - }, - "requestId": { - "type": "string", - "description": "Post Restore request id." - }, - "azureFileShareUri": { - "type": "string", - "description": "Post Restore Azure file share uri." - }, - "status": { - "type": "string", - "description": "Post Restore Azure status." - }, - "sourceAzureFileShareUri": { - "type": "string", - "description": "Post Restore Azure source azure file share uri." - }, - "failedFileList": { - "type": "string", - "description": "Post Restore Azure failed file list." - }, - "restoreFileSpec": { - "type": "array", - "description": "Post Restore restore file spec array.", - "items": { - "$ref": "#/definitions/RestoreFileSpec", - "description": "Post Restore restore file spec items array." - } - } - } - }, - "PreRestoreRequest": { - "type": "object", - "description": "Pre Restore request object.", - "properties": { - "partition": { - "type": "string", - "description": "Pre Restore partition." - }, - "replicaGroup": { - "type": "string", - "description": "Pre Restore replica group." - }, - "requestId": { - "type": "string", - "description": "Pre Restore request id." - }, - "azureFileShareUri": { - "type": "string", - "description": "Pre Restore Azure file share uri." - }, - "status": { - "type": "string", - "description": "Pre Restore Azure status." - }, - "sourceAzureFileShareUri": { - "type": "string", - "description": "Pre Restore Azure source azure file share uri." - }, - "backupMetadataPropertyBag": { - "type": "string", - "description": "Pre Restore backup metadata property bag." - }, - "restoreFileSpec": { - "type": "array", - "description": "Pre Restore restore file spec array.", - "items": { - "$ref": "#/definitions/RestoreFileSpec", - "description": "Pre Restore restore file spec items array." - } - }, - "pauseWaitForSyncDrainTimePeriodInSeconds": { - "type": "integer", - "description": "Pre Restore pause wait for sync drain time period in seconds." - } - } - }, - "BackupRequest": { - "type": "object", - "description": "Backup request", - "properties": { - "azureFileShare": { - "type": "string", - "description": "Azure File Share." - } - } - }, - "PostBackupResponse": { - "type": "object", - "description": "Post Backup Response", - "properties": { - "backupMetadata": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PostBackupResponseProperties", - "description": "Post Backup Response Properties" - } - } - }, - "RestoreFileSpec": { - "type": "object", - "description": "Restore file spec.", - "properties": { - "path": { - "type": "string", - "description": "Restore file spec path" - }, - "isdir": { - "type": "boolean", - "description": "Restore file spec isdir", - "readOnly": true - } - } - }, - "StorageSyncServiceArray": { - "type": "object", - "description": "Array of StorageSyncServices", - "properties": { - "value": { - "type": "array", - "description": "Collection of StorageSyncServices.", - "items": { - "$ref": "#/definitions/StorageSyncService" - } - } - } - }, - "SyncGroupArray": { - "type": "object", - "description": "Array of SyncGroup", - "properties": { - "value": { - "type": "array", - "description": "Collection of SyncGroup.", - "items": { - "$ref": "#/definitions/SyncGroup" - } - } - } - }, - "CloudEndpointArray": { - "type": "object", - "description": "Array of CloudEndpoint", - "properties": { - "value": { - "type": "array", - "description": "Collection of CloudEndpoint.", - "items": { - "$ref": "#/definitions/CloudEndpoint" - } - } - } - }, - "ServerEndpointArray": { - "description": "Array of ServerEndpoint", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of ServerEndpoint.", - "items": { - "$ref": "#/definitions/ServerEndpoint" - } - } - } - }, - "RegisteredServerArray": { - "description": "Array of RegisteredServer", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of Registered Server.", - "items": { - "$ref": "#/definitions/RegisteredServer" - } - } - } - }, - "WorkflowArray": { - "description": "Array of Workflow", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of workflow items.", - "items": { - "$ref": "#/definitions/Workflow" - } - } - } - }, - "SubscriptionStateProperties": { - "type": "object", - "description": "Subscription State properties." - }, - "PostBackupResponseProperties": { - "type": "object", - "description": "Post Backup Response Properties object.", - "properties": { - "cloudEndpointName": { - "type": "string", - "description": "cloud endpoint Name.", - "readOnly": true - } - } - }, - "StorageSyncServiceProperties": { - "type": "object", - "description": "Storage Sync Service Properties object.", - "properties": { - "storageSyncServiceStatus": { - "type": "integer", - "description": "Storage Sync service status.", - "readOnly": true - }, - "storageSyncServiceUid": { - "type": "string", - "description": "Storage Sync service Uid", - "readOnly": true - } - } - }, - "WorkflowProperties": { - "type": "object", - "description": "Workflow Properties object.", - "properties": { - "lastStepName": { - "type": "string", - "description": "last step name" - }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "description": "workflow status." - }, - "operation": { - "$ref": "#/definitions/OperationDirection", - "description": "operation direction." - }, - "steps": { - "type": "string", - "description": "workflow steps" - }, - "lastOperationId": { - "type": "string", - "description": "workflow last operation identifier." - } - } - }, - "SyncGroupProperties": { - "type": "object", - "description": "SyncGroup Properties object.", - "properties": { - "uniqueId": { - "type": "string", - "description": "Unique Id" - }, - "syncGroupStatus": { - "type": "string", - "description": "Sync group status", - "readOnly": true - } - } - }, - "RegisteredServerProperties": { - "type": "object", - "description": "RegisteredServer Properties object.", - "properties": { - "serverCertificate": { - "type": "string", - "description": "Registered Server Certificate" - }, - "agentVersion": { - "type": "string", - "description": "Registered Server Agent Version" - }, - "serverOSVersion": { - "type": "string", - "description": "Registered Server OS Version" - }, - "serverManagementtErrorCode": { - "type": "integer", - "description": "Registered Server Management Error Code" - }, - "lastHeartBeat": { - "type": "string", - "description": "Registered Server last heart beat" - }, - "provisioningState": { - "type": "string", - "description": "Registered Server Provisioning State" - }, - "serverRole": { - "type": "string", - "description": "Registered Server serverRole" - }, - "clusterId": { - "type": "string", - "description": "Registered Server clusterId" - }, - "clusterName": { - "type": "string", - "description": "Registered Server clusterName" - }, - "serverId": { - "type": "string", - "description": "Registered Server serverId" - }, - "storageSyncServiceUid": { - "type": "string", - "description": "Registered Server storageSyncServiceUid" - }, - "lastWorkflowId": { - "type": "string", - "description": "Registered Server lastWorkflowId" - } - } - }, - "CloudEndpointProperties": { - "type": "object", - "description": "CloudEndpoint Properties object.", - "properties": { - "storageAccountKey": { - "type": "string", - "description": "Storage Account access key." - }, - "storageAccount": { - "type": "string", - "description": "Storage Account name." - }, - "storageAccountResourceId": { - "type": "string", - "description": "Storage Account Resource Id" - }, - "storageAccountShareName": { - "type": "string", - "description": "Storage Account Share name" - }, - "storageAccountTenantId": { - "type": "string", - "description": "Storage Account Tenant Id" - }, - "partnershipId": { - "type": "string", - "description": "Partnership Id" - }, - "friendlyName": { - "type": "string", - "description": "Friendly Name" - }, - "backupEnabled": { - "type": "boolean", - "description": "Backup Enabled", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "CloudEndpoint Provisioning State" - }, - "lastWorkflowId": { - "type": "string", - "description": "CloudEndpoint lastWorkflowId" - } - } - }, - "ServerEndpointProperties": { - "type": "object", - "description": "ServerEndpoint Properties object.", - "properties": { - "serverLocalPath": { - "$ref": "#/definitions/PhysicalPath", - "description": "Server Local path." - }, - "cloudTiering": { - "$ref": "#/definitions/FeatureStatus", - "description": "Cloud Tiering." - }, - "volumeFreeSpacePercent": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." - }, - "friendlyName": { - "type": "string", - "description": "Friendly Name" - }, - "lastSyncSuccess": { - "type": "string", - "format": "date-time", - "description": "Last Sync Success" - }, - "syncErrorState": { - "type": "string", - "description": "Sync Error State" - }, - "syncErrorStateTimestamp": { - "type": "string", - "format": "date-time", - "description": "Sync Error State Timestamp" - }, - "syncErrorDirection": { - "$ref": "#/definitions/ProgressType", - "description": "Sync Error Direction." - }, - "itemUploadErrorCount": { - "type": "integer", - "description": "Item Upload Error Count." - }, - "itemDownloadErrorCount": { - "type": "integer", - "description": "Item download error count." - }, - "syncErrorContext": { - "type": "string", - "description": "sync error context." - }, - "currentProgressType": { - "$ref": "#/definitions/ProgressType", - "description": "current progress type." - }, - "itemProgressCount": { - "type": "integer", - "description": "Item Progress Count" - }, - "itemTotalCount": { - "type": "integer", - "description": "Item Total Count" - }, - "byteProgress": { - "type": "integer", - "description": "Bytes in progress" - }, - "totalProgress": { - "type": "integer", - "description": "Total progress" - }, - "byteTotal": { - "type": "integer", - "description": "Bytes total" - }, - "serverResourceId": { - "$ref": "#/definitions/ResourceId", - "description": "Server Resource Id." - }, - "provisioningState": { - "type": "string", - "description": "ServerEndpoint Provisioning State" - }, - "lastWorkflowId": { - "type": "string", - "description": "ServerEndpoint lastWorkflowId" - } - } - }, - "PhysicalPath": { - "type": "string", - "description": "Server folder used for data synchronization" - }, - "ResourceId": { - "type": "string", - "description": "Arm resource identifier." - }, - "TagsObject": { - "type": "object", - "description": "Tags object." - }, - "FeatureStatus": { - "type": "string", - "description": "Type of the Feature Status", - "enum": [ - "on", - "off" - ] - }, - "WorkflowStatus": { - "type": "string", - "description": "Type of the Workflow Status", - "enum": [ - "active", - "expired", - "succeeded", - "aborted", - "failed" - ] - }, - "OperationDirection": { - "type": "string", - "description": "Type of the Operation Direction", - "enum": [ - "do", - "undo", - "cancel" - ] - }, - "ProgressType": { - "type": "string", - "description": "Type of the ProgressType", - "enum": [ - "none", - "initialize", - "download", - "upload", - "recall" - ] - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Storage Sync", + "description": "Microsoft Storage Sync Service API", + "version": "2017-06-05-preview", + "x-ms-code-generation-settings": { + "name": "StorageSyncManagementClient" + } + }, + "host": "azure.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.StorageSync/operations": { + "get": { + "tags": [ + "ResourceProvider", + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "description": "Lists all of the available Storage Sync Rest API operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "responses": { + "200": { + "description": "Array of operations resources in the Resource Provider", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource name.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Create", + "description": "Create a new StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Create": { + "$ref": "./examples/StorageSyncServices_Create.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Get", + "description": "Get a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Get": { + "$ref": "./examples/StorageSyncServices_Get.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "patch": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource.", + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Update", + "description": "Patch a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Update": { + "$ref": "./examples/StorageSyncServices_Update.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Delete", + "description": "Delete a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Delete": { + "$ref": "./examples/StorageSyncServices_Delete.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object was deleted.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "204": { + "description": "Storage Sync Service Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListByResourceGroup", + "description": "Get a StorageSyncService list by Resource group name.", + "x-ms-examples": { + "StorageSyncServices_ListByResourceGroup": { + "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the Resource Group", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListBySubscription", + "description": "Get a StorageSyncService list by subscription.", + "x-ms-examples": { + "StorageSyncServices_ListBySubscription": { + "$ref": "./examples/StorageSyncServices_ListBySubscription.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the subscription.", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_ListByStorageSyncService", + "description": "Get a SyncGroup List.", + "x-ms-examples": { + "SyncGroups_ListByStorageSyncService": { + "$ref": "./examples/SyncGroups_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Sync Group resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/SyncGroupArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Sync Group Body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncGroup" + } + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Create", + "description": "Create a new SyncGroup.", + "x-ms-examples": { + "SyncGroups_Create": { + "$ref": "./examples/SyncGroups_Create.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Get", + "description": "Get a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Get": { + "$ref": "./examples/SyncGroups_Get.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Delete", + "description": "Delete a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Delete": { + "$ref": "./examples/SyncGroups_Delete.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object was deleted", + "headers": { + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint resource.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudEndpoint" + } + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Create", + "description": "Create a new CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Create": { + "$ref": "./examples/CloudEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Get", + "description": "Get a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Get": { + "$ref": "./examples/CloudEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Delete", + "description": "Delete a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Delete": { + "$ref": "./examples/CloudEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_ListBySyncGroup", + "description": "Get a CloudEndpoint List.", + "x-ms-examples": { + "CloudEndpoints_ListBySyncGroup": { + "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Cloud Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/CloudEndpointArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreBackup", + "description": "Pre Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreBackup": { + "$ref": "./examples/CloudEndpoints_PreBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostBackup", + "description": "Post Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostBackup": { + "$ref": "./examples/CloudEndpoints_PostBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/PostBackupResponse" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PreRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreRestore", + "description": "Pre Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreRestore": { + "$ref": "./examples/CloudEndpoints_PreRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_RestoreHeatbeat", + "description": "Restore Heartbeat a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_RestoreHeatbeat": { + "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json" + } + }, + "responses": { + "200": { + "description": "Restore Heartbeat Operation has ran successfully.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PostRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostRestore", + "description": "Post Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostRestore": { + "$ref": "./examples/CloudEndpoints_PostRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Server Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerEndpoint" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Create", + "description": "Create a new ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Create": { + "$ref": "./examples/ServerEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Any of the properties applicable in PUT request.", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Update", + "description": "Patch a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Update": { + "$ref": "./examples/ServerEndpoints_Update.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Get", + "description": "Get a ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Get": { + "$ref": "./examples/ServerEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Delete", + "description": "Delete a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Delete": { + "$ref": "./examples/ServerEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_ListBySyncGroup", + "description": "Get a ServerEndpoint list.", + "x-ms-examples": { + "ServerEndpoints_ListBySyncGroup": { + "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Server Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/ServerEndpointArray" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource", + "Actions" + ], + "operationId": "ServerEndpoints_Recall", + "description": "Recall a serverendpoint.", + "x-ms-examples": { + "ServerEndpoints_Recall": { + "$ref": "./examples/ServerEndpoints_Recall.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_ListByStorageSyncService", + "description": "Get a given registered server list.", + "x-ms-examples": { + "RegisteredServers_ListByStorageSyncService": { + "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Registered Server resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/RegisteredServerArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Get", + "description": "Get a given registered server.", + "x-ms-examples": { + "RegisteredServers_Get": { + "$ref": "./examples/RegisteredServers_Get.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Registered Server object.", + "required": true, + "schema": { + "$ref": "#/definitions/RegisteredServer" + } + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Create", + "description": "Add a new registered server.", + "x-ms-examples": { + "RegisteredServers_Create": { + "$ref": "./examples/RegisteredServers_Create.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Delete", + "description": "Delete the given registered server.", + "x-ms-examples": { + "RegisteredServers_Delete": { + "$ref": "./examples/RegisteredServers_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronuous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource" + ], + "operationId": "Workflows_Get", + "description": "Get Workflows resource", + "x-ms-examples": { + "Workflows_Get": { + "$ref": "./examples/Workflows_Get.json" + } + }, + "responses": { + "200": { + "description": "Workflow object", + "schema": { + "$ref": "#/definitions/Workflow" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource", + "Actions" + ], + "operationId": "Workflows_Abort", + "description": "Abort the given workflow.", + "x-ms-examples": { + "Workflows_Abort": { + "$ref": "./examples/Workflows_Abort.json" + } + }, + "responses": { + "200": { + "description": "success", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + } + }, + "definitions": { + "StorageSyncError": { + "type": "object", + "description": "Error type", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "details": { + "$ref": "#/definitions/StorageSyncErrorDetails", + "description": "Error details of the given entry." + } + } + }, + "StorageSyncErrorDetails": { + "type": "object", + "description": "Error Details object.", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given entry." + } + } + }, + "Resource": { + "description": "The Azure Resource Manager resource.", + "properties": { + "id": { + "description": "The id of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the resource", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object" + } + } + }, + "SubscriptionState": { + "type": "object", + "description": "Subscription State object.", + "properties": { + "state": { + "type": "string", + "description": "State of Azure Subscription", + "enum": [ + "Registered", + "Unregistered", + "Warned", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "istransitioning": { + "type": "boolean", + "description": "Is Transitioning", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionStateProperties", + "description": "Subscription state properties." + } + } + }, + "StorageSyncService": { + "type": "object", + "description": "Storage Sync Service object.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceProperties", + "description": "Storage Sync Service properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "SyncGroup": { + "type": "object", + "description": "Sync Group object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupProperties", + "description": "SyncGroup properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "CloudEndpoint": { + "type": "object", + "description": "Cloud Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointProperties", + "description": "Cloud Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "ServerEndpoint": { + "type": "object", + "description": "Server Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointProperties", + "description": "Server Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "RegisteredServer": { + "type": "object", + "description": "Registered Server resource.", + "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" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerProperties", + "description": "RegisteredServer properties." + } + }, + "x-ms-azure-resource": true + }, + "ResourcesMoveInfo": { + "type": "object", + "description": "Resource Move Info.", + "properties": { + "targetResourceGroup": { + "type": "string", + "description": "Target resource group." + }, + "resources": { + "type": "array", + "description": "Collection of Resources.", + "items": { + "$ref": "#/definitions/ResourceId" + } + } + } + }, + "Workflow": { + "type": "object", + "description": "Workflow resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "Workflow properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "OperationEntityListResult": { + "description": "The list of storage sync operations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by storage sync." + }, + "origin": { + "type": "string", + "description": "The origin." + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft StorageSync.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "OperationDisplayResource": { + "type": "object", + "description": "Operation Display Resource object.", + "properties": { + "provider": { + "type": "string", + "description": "Operation Display Resource Provider." + }, + "resource": { + "type": "string", + "description": "Operation Display Resource." + }, + "operation": { + "type": "string", + "description": "Operation Display Resource Operation." + }, + "description": { + "type": "string", + "description": "Operation Display Resource Description." + } + } + }, + "PostRestoreRequest": { + "type": "object", + "description": "Post Restore Request", + "properties": { + "partition": { + "type": "string", + "description": "Post Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Post Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Post Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Post Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Post Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Post Restore Azure source azure file share uri." + }, + "failedFileList": { + "type": "string", + "description": "Post Restore Azure failed file list." + }, + "restoreFileSpec": { + "type": "array", + "description": "Post Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Post Restore restore file spec items array." + } + } + } + }, + "PreRestoreRequest": { + "type": "object", + "description": "Pre Restore request object.", + "properties": { + "partition": { + "type": "string", + "description": "Pre Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Pre Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Pre Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Pre Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure source azure file share uri." + }, + "backupMetadataPropertyBag": { + "type": "string", + "description": "Pre Restore backup metadata property bag." + }, + "restoreFileSpec": { + "type": "array", + "description": "Pre Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Pre Restore restore file spec items array." + } + }, + "pauseWaitForSyncDrainTimePeriodInSeconds": { + "type": "integer", + "description": "Pre Restore pause wait for sync drain time period in seconds." + } + } + }, + "BackupRequest": { + "type": "object", + "description": "Backup request", + "properties": { + "azureFileShare": { + "type": "string", + "description": "Azure File Share." + } + } + }, + "PostBackupResponse": { + "type": "object", + "description": "Post Backup Response", + "properties": { + "backupMetadata": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostBackupResponseProperties", + "description": "Post Backup Response Properties" + } + } + }, + "RestoreFileSpec": { + "type": "object", + "description": "Restore file spec.", + "properties": { + "path": { + "type": "string", + "description": "Restore file spec path" + }, + "isdir": { + "type": "boolean", + "description": "Restore file spec isdir", + "readOnly": true + } + } + }, + "StorageSyncServiceArray": { + "type": "object", + "description": "Array of StorageSyncServices", + "properties": { + "value": { + "type": "array", + "description": "Collection of StorageSyncServices.", + "items": { + "$ref": "#/definitions/StorageSyncService" + } + } + } + }, + "SyncGroupArray": { + "type": "object", + "description": "Array of SyncGroup", + "properties": { + "value": { + "type": "array", + "description": "Collection of SyncGroup.", + "items": { + "$ref": "#/definitions/SyncGroup" + } + } + } + }, + "CloudEndpointArray": { + "type": "object", + "description": "Array of CloudEndpoint", + "properties": { + "value": { + "type": "array", + "description": "Collection of CloudEndpoint.", + "items": { + "$ref": "#/definitions/CloudEndpoint" + } + } + } + }, + "ServerEndpointArray": { + "description": "Array of ServerEndpoint", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of ServerEndpoint.", + "items": { + "$ref": "#/definitions/ServerEndpoint" + } + } + } + }, + "RegisteredServerArray": { + "description": "Array of RegisteredServer", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of Registered Server.", + "items": { + "$ref": "#/definitions/RegisteredServer" + } + } + } + }, + "WorkflowArray": { + "description": "Array of Workflow", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of workflow items.", + "items": { + "$ref": "#/definitions/Workflow" + } + } + } + }, + "SubscriptionStateProperties": { + "type": "object", + "description": "Subscription State properties." + }, + "PostBackupResponseProperties": { + "type": "object", + "description": "Post Backup Response Properties object.", + "properties": { + "cloudEndpointName": { + "type": "string", + "description": "cloud endpoint Name.", + "readOnly": true + } + } + }, + "StorageSyncServiceProperties": { + "type": "object", + "description": "Storage Sync Service Properties object.", + "properties": { + "storageSyncServiceStatus": { + "type": "integer", + "description": "Storage Sync service status.", + "readOnly": true + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Storage Sync service Uid", + "readOnly": true + } + } + }, + "WorkflowProperties": { + "type": "object", + "description": "Workflow Properties object.", + "properties": { + "lastStepName": { + "type": "string", + "description": "last step name" + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "workflow status." + }, + "operation": { + "$ref": "#/definitions/OperationDirection", + "description": "operation direction." + }, + "steps": { + "type": "string", + "description": "workflow steps" + }, + "lastOperationId": { + "type": "string", + "description": "workflow last operation identifier." + } + } + }, + "SyncGroupProperties": { + "type": "object", + "description": "SyncGroup Properties object.", + "properties": { + "uniqueId": { + "type": "string", + "description": "Unique Id" + }, + "syncGroupStatus": { + "type": "string", + "description": "Sync group status", + "readOnly": true + } + } + }, + "RegisteredServerProperties": { + "type": "object", + "description": "RegisteredServer Properties object.", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "serverManagementtErrorCode": { + "type": "integer", + "description": "Registered Server Management Error Code" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "provisioningState": { + "type": "string", + "description": "Registered Server Provisioning State" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Registered Server storageSyncServiceUid" + }, + "lastWorkflowId": { + "type": "string", + "description": "Registered Server lastWorkflowId" + } + } + }, + "CloudEndpointProperties": { + "type": "object", + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountKey": { + "type": "string", + "description": "Storage Account access key." + }, + "storageAccount": { + "type": "string", + "description": "Storage Account name." + }, + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "backupEnabled": { + "type": "boolean", + "description": "Backup Enabled", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "CloudEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "CloudEndpoint lastWorkflowId" + } + } + }, + "ServerEndpointProperties": { + "type": "object", + "description": "ServerEndpoint Properties object.", + "properties": { + "serverLocalPath": { + "$ref": "#/definitions/PhysicalPath", + "description": "Server Local path." + }, + "cloudTiering": { + "$ref": "#/definitions/FeatureStatus", + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "lastSyncSuccess": { + "type": "string", + "format": "date-time", + "description": "Last Sync Success" + }, + "syncErrorState": { + "type": "string", + "description": "Sync Error State" + }, + "syncErrorStateTimestamp": { + "type": "string", + "format": "date-time", + "description": "Sync Error State Timestamp" + }, + "syncErrorDirection": { + "$ref": "#/definitions/ProgressType", + "description": "Sync Error Direction." + }, + "itemUploadErrorCount": { + "type": "integer", + "description": "Item Upload Error Count." + }, + "itemDownloadErrorCount": { + "type": "integer", + "description": "Item download error count." + }, + "syncErrorContext": { + "type": "string", + "description": "sync error context." + }, + "currentProgressType": { + "$ref": "#/definitions/ProgressType", + "description": "current progress type." + }, + "itemProgressCount": { + "type": "integer", + "description": "Item Progress Count" + }, + "itemTotalCount": { + "type": "integer", + "description": "Item Total Count" + }, + "byteProgress": { + "type": "integer", + "description": "Bytes in progress" + }, + "totalProgress": { + "type": "integer", + "description": "Total progress" + }, + "byteTotal": { + "type": "integer", + "description": "Bytes total" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId" + } + } + }, + "PhysicalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "ResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "TagsObject": { + "type": "object", + "description": "Tags object." + }, + "FeatureStatus": { + "type": "string", + "description": "Type of the Feature Status", + "enum": [ + "on", + "off" + ] + }, + "WorkflowStatus": { + "type": "string", + "description": "Type of the Workflow Status", + "enum": [ + "active", + "expired", + "succeeded", + "aborted", + "failed" + ] + }, + "OperationDirection": { + "type": "string", + "description": "Type of the Operation Direction", + "enum": [ + "do", + "undo", + "cancel" + ] + }, + "ProgressType": { + "type": "string", + "description": "Type of the ProgressType", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json index 2cc17119c0c2..be7b1b720fd2 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/examples/EnvironmentsGetExpandStatus.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "subid", - "environmentName": "env1", - "resourceGroupName": "rg1", - "api-version": "2017-11-15", - "$expand": "status" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", - "location": "West US", - "name": "env1", - "type": "Microsoft.TimeSeriesInsights/Environments", - "tags": {}, - "properties": { - "dataRetentionTime": "P31D", - "provisioningState": "Succeeded", - "creationTime": "2017-04-18T19:20:33.2288820Z", - "storageLimitExceededBehavior": "PurgeOldData", - "partitionKeyProperties": [ - { - "name": "DeviceId1", - "type": "String" - } - ], - "dataAccessId": "", - "dataAccessFqdn": "", - "status": { - "ingress": { - "state": "Running" - } - } - }, - "sku": { - "name": "S1", - "capacity": 1 - } - } - } - } +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2017-11-15", + "$expand": "status" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "storageLimitExceededBehavior": "PurgeOldData", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ], + "dataAccessId": "", + "dataAccessFqdn": "", + "status": { + "ingress": { + "state": "Running" + } + } + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + } + } } \ No newline at end of file diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateExtensionResource.json index cac3d48312d3..9fe6920a3d6b 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateProjectResource.json index 99b8027ee878..846f2adc2355 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/project/ExampleProject", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateResource.json index 8cb8cb7ad92e..a8e886c437bc 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/CreateResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteExtensionResource.json index 670b245b8a91..bca206e7733d 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteResource.json index 4ef83e4990a6..a64eaa56fd8f 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/DeleteResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResource.json index b7f57934ed82..cc8752868373 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResources_List.json index 779a8c5d631a..2401892ee1df 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetExtensionResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetOperations.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetOperations.json index 3ba293294ce1..bcbd5a6814af 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetOperations.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2014-04-01-preview" }, diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectJobStatus.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectJobStatus.json index 5a6550ac13cb..5f6ddec82e31 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectJobStatus.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectJobStatus.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResource.json index 2d687c8f76f2..de82e89461af 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResources_List.json index ed4f03480813..f03298e6d66b 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetProjectResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResource.json index 7bb840b3f26a..86996c4ff992 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResources_List.json index fece9e32020a..75cda1318d8c 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/GetResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateExtensionResource.json index 8c0167ebfdc1..38b72c46d300 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateProjectResource.json index c17f27abcb21..ead3e5c04fa8 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/microsoft.visualstudio/account/ExampleAccount/project/ExampleProject", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateExtensionResource.json index cac3d48312d3..9fe6920a3d6b 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateProjectResource.json index af208d577c60..b1488b3ac23d 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/project/ExampleProject", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateResource.json index 8cb8cb7ad92e..a8e886c437bc 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/CreateResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteExtensionResource.json index 670b245b8a91..bca206e7733d 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteResource.json index 4ef83e4990a6..a64eaa56fd8f 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/DeleteResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResource.json index b7f57934ed82..cc8752868373 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResources_List.json index 779a8c5d631a..2401892ee1df 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetExtensionResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetOperations.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetOperations.json index 3ba293294ce1..bcbd5a6814af 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetOperations.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetOperations.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2014-04-01-preview" }, diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResource.json index e0396ae43d5f..4c80741052c0 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResources_List.json index 4cc9b35bbaaa..2f3476832edd 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetProjectResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResource.json index 7bb840b3f26a..86996c4ff992 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResources_List.json index fece9e32020a..75cda1318d8c 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/GetResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateExtensionResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateExtensionResource.json index 8c0167ebfdc1..38b72c46d300 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateExtensionResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateExtensionResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "location": "Central US", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateProjectResource.json index 361b2a7b1c84..649b65aae37c 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2017-11-01-preview/examples/UpdateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "tags": { diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/CreateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/CreateProjectResource.json index bb3753c4f60d..c507b9fdf1b0 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/CreateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/CreateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/ExampleAccount/project/ExampleProject", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetPipelineTemplates_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetPipelineTemplates_List.json index 7f9e07da9998..24dc5af80b8f 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetPipelineTemplates_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetPipelineTemplates_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "api-version": "2018-08-01-preview" }, diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResource.json index 91b87f0e350b..ec88aa24f2a5 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResources_List.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResources_List.json index e5a3bf5a2ba9..6dc0b4eb762e 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResources_List.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/GetProjectResources_List.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", "resourceGroupName": "VS-Example-Group", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/UpdateProjectResource.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/UpdateProjectResource.json index bc9bad0d763c..5572f446ccac 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/UpdateProjectResource.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2018-08-01-preview/examples/UpdateProjectResource.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "body": { "tags": {